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
data.type	string	Should be "workspace"
data.attributes.name	string	Unique workspace for an Terrakube organization
data.attributes.branch	boolean	Git branch to be used
data.attributes.source	boolean	Git repository to be used
data.attributes.terraformVersion	boolean	Terraform version to run the workspace
data.relationships.vcs.data.type	string	Should be "vcs" (OPTIONAL)
data.relationships.vcs.data.type	string	Should be the VCS Connection Id (OPTIONAL)

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

get

Returns an instance of type module

Path parameters

organizationIdanyRequired

organization Identifier

moduleIdanyRequired

module Identifier

Query parameters

fields[module]anyOptional

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

includeanyOptional

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

Responses

get

HTTPcURLJavaScriptPython

GET /organization/{organizationId}/module/{moduleId} HTTP/1.1
Host: 
Accept: */*

200

Successful response

{
  "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": [
    {
      "attributes": {},
      "id": "text",
      "relationships": {},
      "type": "text"
    }
  ]
}

post

Creates an item of type module and adds it to module

Path parameters

organizationIdanyRequired

organization Identifier

Body

Responses

post

HTTPcURLJavaScriptPython

POST /organization/{organizationId}/module HTTP/1.1
Host: 
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 249

{
  "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"
      }
    }
  }
}

201

Successful response

{
  "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"
      }
    }
  }
}

delete

Deletes an instance of type module

Path parameters

organizationIdanyRequired

organization Identifier

moduleIdanyRequired

module Identifier

Responses

delete

HTTPcURLJavaScriptPython

DELETE /organization/{organizationId}/module/{moduleId} HTTP/1.1
Host: 
Accept: */*

204

Successful response

No content

patch

Modifies an instance of type module

Path parameters

organizationIdanyRequired

organization Identifier

moduleIdanyRequired

module Identifier

Body

Responses

patch

HTTPcURLJavaScriptPython

PATCH /organization/{organizationId}/module/{moduleId} HTTP/1.1
Host: 
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 249

{
  "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"
      }
    }
  }
}

204

Successful response

No content

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