1 of 1

Module

This endpoint is used to create, update, search or delete module information inside a Terrakube organization.

To use this endpoint you should have "manageModule" access at team level and a Terrakube organization

Entity fields:

Path

Type

Description

Example:

{
  "data": {
    "type": "module",
    "attributes": {
      "name": "Terrakube module",
      "description": "Module Description",
      "provider": "Terraform Provider",
      "source": "https://github.com/AzBuilder/terraform-sample-repository.git"
    },
        "relationships": {
            "vcs": {
                "data": {
                    "type": "vcs",
                    "id": "{{vcsId}}"
                }
            }
        }
  }
}

Supported Operations

For a complete list of organization operation please visit the OpenAPI specification

Module

This endpoint is used to create, update, search or delete module information inside a Terrakube organization.

To use this endpoint you should have "manageModule" access at team level and a Terrakube organization

Entity fields:

Path

Type

Description

Example:

{
  "data": {
    "type": "module",
    "attributes": {
      "name": "Terrakube module",
      "description": "Module Description",
      "provider": "Terraform Provider",
      "source": "https://github.com/AzBuilder/terraform-sample-repository.git"
    },
        "relationships": {
            "vcs": {
                "data": {
                    "type": "vcs",
                    "id": "{{vcsId}}"
                }
            }
        }
  }
}

Supported Operations

Returns an instance of type module

GET/api/v1/organization/{organizationId}/module/{moduleId}

Path parameters

organizationId*string

organization Identifier

moduleId*string

module Identifier

Query parameters

fields[module]array of enum

Selects the set of module fields that should be returned in the result.

itemsenum

descriptionnameproviderregistryPathsourcesourceSampleversionsorganization

includearray of enum

Selects the set of relationships that should be expanded as a compound document in the result.

itemsenum

organization

Response

Successful response

Body

datamodule (object)

typestring

idstring

attributesobject

descriptionstring

namestring

providerstring

registryPathstring

sourcestring

sourceSamplestring

versionsarray of object

relationshipsobject

organizationobject

idstring

typeenum

organization

includedarray of object

Included resources

attributesobject

idstring

relationshipsobject

typestring

Request

Response

Creates an item of type module and adds it to module

POST/api/v1/organization/{organizationId}/module

Path parameters

organizationId*string

organization Identifier

Body

datamodule (object)

typestring

idstring

attributesobject

descriptionstring

namestring

providerstring

registryPathstring

sourcestring

sourceSamplestring

versionsarray of object

relationshipsobject

organizationobject

idstring

typeenum

organization

Response

Successful response

Body

datamodule (object)

typestring

idstring

attributesobject

descriptionstring

namestring

providerstring

registryPathstring

sourcestring

sourceSamplestring

versionsarray of object

relationshipsobject

organizationobject

idstring

typeenum

organization

Request

Response

Deletes an instance of type module

DELETE/api/v1/organization/{organizationId}/module/{moduleId}

Path parameters

organizationId*string

organization Identifier

moduleId*string

module Identifier

Response

Successful response

Request

Modifies an instance of type module

PATCH/api/v1/organization/{organizationId}/module/{moduleId}

Path parameters

organizationId*string

organization Identifier

moduleId*string

module Identifier

Body

datamodule (object)

typestring

idstring

attributesobject

descriptionstring

namestring

providerstring

registryPathstring

sourcestring

sourceSamplestring

versionsarray of object

relationshipsobject

organizationobject

idstring

typeenum

organization

Response

Successful response

Request

For a complete list of organization operation please visit the OpenAPI specification

Deletes an instance of type module

DELETE/api/v1/organization/{organizationId}/module/{moduleId}

Path parameters

organizationId*string

organization Identifier

moduleId*string

module Identifier

Response

Successful response

Request

Modifies an instance of type module

PATCH/api/v1/organization/{organizationId}/module/{moduleId}

Path parameters

organizationId*string

organization Identifier

moduleId*string

module Identifier

Body

datamodule (object)

typestring

idstring

attributesobject

descriptionstring

namestring

providerstring

registryPathstring

sourcestring

sourceSamplestring

versionsarray of object

relationshipsobject

organizationobject

idstring

typeenum

organization

Response

Successful response

Request

Creates an item of type module and adds it to module

POST/api/v1/organization/{organizationId}/module

Path parameters

organizationId*string

organization Identifier

Body

datamodule (object)

typestring

idstring

attributesobject

descriptionstring

namestring

providerstring

registryPathstring

sourcestring

sourceSamplestring

versionsarray of object

relationshipsobject

organizationobject

idstring

typeenum

organization

Response

Successful response

Body

datamodule (object)

typestring

idstring

attributesobject

descriptionstring

namestring

providerstring

registryPathstring

sourcestring

sourceSamplestring

versionsarray of object

relationshipsobject

organizationobject

idstring

typeenum

organization

Request

Response

Returns an instance of type module

GET/api/v1/organization/{organizationId}/module/{moduleId}

Path parameters

organizationId*string

organization Identifier

moduleId*string

module Identifier

Query parameters

fields[module]array of enum

Selects the set of module fields that should be returned in the result.

itemsenum

descriptionnameproviderregistryPathsourcesourceSampleversionsorganization

includearray of enum

Selects the set of relationships that should be expanded as a compound document in the result.

itemsenum

organization

Response

Successful response

Body

datamodule (object)

typestring

idstring

attributesobject

descriptionstring

namestring

providerstring

registryPathstring

sourcestring

sourceSamplestring

versionsarray of object

relationshipsobject

organizationobject

idstring

typeenum

organization

includedarray of object

Included resources

attributesobject

idstring

relationshipsobject

typestring

Request

Response

const response = await fetch('/api/v1/organization/{organizationId}/module/{moduleId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

const response = await fetch('/api/v1/organization/{organizationId}/module/{moduleId}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/vnd.api+json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

const response = await fetch('/api/v1/organization/{organizationId}/module', {
    method: 'POST',
    headers: {
      "Content-Type": "application/vnd.api+json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

{
  "data": {
    "type": "text",
    "id": "text",
    "attributes": {
      "description": "text",
      "name": "text",
      "provider": "text",
      "registryPath": "text",
      "source": "text",
      "sourceSample": "text",
      "versions": []
    },
    "relationships": {
      "organization": {
        "id": "text",
        "type": "organization"
      }
    }
  }
}

const response = await fetch('/api/v1/organization/{organizationId}/module/{moduleId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

{
  "data": {
    "type": "text",
    "id": "text",
    "attributes": {
      "description": "text",
      "name": "text",
      "provider": "text",
      "registryPath": "text",
      "source": "text",
      "sourceSample": "text",
      "versions": []
    },
    "relationships": {
      "organization": {
        "id": "text",
        "type": "organization"
      }
    }
  },
  "included": [
    {
      "id": "text",
      "type": "text"
    }
  ]
}