1 of 1

Template

This endpoint is used to create, update, search or delete teamplates inside an organization.

Entity fields:

Path

Type

Description

To better understand Terrakube Configuration Language job templates please refer to the following GitHub repository.

Example:

{
  "data": {
    "type": "template",
    "attributes": {
      "name": "Some name",
      "description": "Some description",
      "version": "1.0.0",
      "tcl": "{{templateSample}}"
    }
  }
}

Supported Operations

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

Template

This endpoint is used to create, update, search or delete teamplates inside an organization.

Entity fields:

Path

Type

Description

To better understand Terrakube Configuration Language job templates please refer to the following GitHub repository.

Example:

{
  "data": {
    "type": "template",
    "attributes": {
      "name": "Some name",
      "description": "Some description",
      "version": "1.0.0",
      "tcl": "{{templateSample}}"
    }
  }
}

Supported Operations

Returns an instance of type template

GET/api/v1/organization/{organizationId}/template/{templateId}

Path parameters

organizationId*string

organization Identifier

templateId*string

template Identifier

Query parameters

fields[template]array of enum

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

itemsenum

createdBycreatedDatedescriptionnametclupdatedByupdatedDateversionorganization

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

datatemplate (object)

typestring

Create Permissions : (team manage template) Delete Permissions : (team manage template)

idstring

attributesobject

createdBystring

Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)

createdDatestring (date-time)

Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)

descriptionstring

Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)

namestring

Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)

tclstring

Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)

updatedBystring

Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)

updatedDatestring (date-time)

Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)

versionstring

Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)

relationshipsobject

organizationobject

Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)

idstring

typeenum

organization

includedarray of object

Included resources

attributesobject

idstring

relationshipsobject

typestring

Request

Response

Creates an item of type template and adds it to template

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

Path parameters

organizationId*string

organization Identifier

Body

datatemplate (object)

typestring

Create Permissions : (team manage template) Delete Permissions : (team manage template)

idstring

attributesobject

createdBystring

Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)

createdDatestring (date-time)

Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)

descriptionstring

Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)

namestring

Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)

tclstring

Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)

updatedBystring

Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)

updatedDatestring (date-time)

Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)

versionstring

Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)

relationshipsobject

organizationobject

Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)

idstring

typeenum

organization

Response

Successful response

Body

datatemplate (object)

typestring

Create Permissions : (team manage template) Delete Permissions : (team manage template)

idstring

attributesobject

createdBystring

Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)

createdDatestring (date-time)

Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)

descriptionstring

Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)

namestring

Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)

tclstring

Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)

updatedBystring

Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)

updatedDatestring (date-time)

Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)

versionstring

Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)

relationshipsobject

organizationobject

Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)

idstring

typeenum

organization

Request

Response

Deletes an instance of type template

DELETE/api/v1/organization/{organizationId}/template/{templateId}

Path parameters

organizationId*string

organization Identifier

templateId*string

template Identifier

Response

Successful response

Request

Modifies an instance of type template

PATCH/api/v1/organization/{organizationId}/template/{templateId}

Path parameters

organizationId*string

organization Identifier

templateId*string

template Identifier

Body

datatemplate (object)

typestring

Create Permissions : (team manage template) Delete Permissions : (team manage template)

idstring

attributesobject

createdBystring

Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)

createdDatestring (date-time)

Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)

descriptionstring

Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)

namestring

Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)

tclstring

Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)

updatedBystring

Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)

updatedDatestring (date-time)

Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)

versionstring

Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)

relationshipsobject

organizationobject

Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)

idstring

typeenum

organization

Response

Successful response

Request

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

Deletes an instance of type template

DELETE/api/v1/organization/{organizationId}/template/{templateId}

Path parameters

organizationId*string

organization Identifier

templateId*string

template Identifier

Response

Successful response

Request

Modifies an instance of type template

PATCH/api/v1/organization/{organizationId}/template/{templateId}

Path parameters

organizationId*string

organization Identifier

templateId*string

template Identifier

Body

datatemplate (object)

typestring

Create Permissions : (team manage template) Delete Permissions : (team manage template)

idstring

attributesobject

createdBystring

Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)

createdDatestring (date-time)

Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)

descriptionstring

Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)

namestring

Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)

tclstring

Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)

updatedBystring

Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)

updatedDatestring (date-time)

Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)

versionstring

Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)

relationshipsobject

organizationobject

Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)

idstring

typeenum

organization

Response

Successful response

Request

Creates an item of type template and adds it to template

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

Path parameters

organizationId*string

organization Identifier

Body

datatemplate (object)

typestring

Create Permissions : (team manage template) Delete Permissions : (team manage template)

idstring

attributesobject

createdBystring

Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)

createdDatestring (date-time)

Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)

descriptionstring

Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)

namestring

Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)

tclstring

Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)

updatedBystring

Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)

updatedDatestring (date-time)

Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)

versionstring

Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)

relationshipsobject

organizationobject

Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)

idstring

typeenum

organization

Response

Successful response

Body

datatemplate (object)

typestring

Create Permissions : (team manage template) Delete Permissions : (team manage template)

idstring

attributesobject

createdBystring

Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)

createdDatestring (date-time)

Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)

descriptionstring

Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)

namestring

Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)

tclstring

Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)

updatedBystring

Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)

updatedDatestring (date-time)

Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)

versionstring

Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)

relationshipsobject

organizationobject

Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)

idstring

typeenum

organization

Request

Response

Returns an instance of type template

GET/api/v1/organization/{organizationId}/template/{templateId}

Path parameters

organizationId*string

organization Identifier

templateId*string

template Identifier

Query parameters

fields[template]array of enum

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

itemsenum

createdBycreatedDatedescriptionnametclupdatedByupdatedDateversionorganization

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

datatemplate (object)

typestring

Create Permissions : (team manage template) Delete Permissions : (team manage template)

idstring

attributesobject

createdBystring

Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)

createdDatestring (date-time)

Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)

descriptionstring

Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)

namestring

Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)

tclstring

Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)

updatedBystring

Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)

updatedDatestring (date-time)

Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)

versionstring

Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)

relationshipsobject

organizationobject

Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)

idstring

typeenum

organization

includedarray of object

Included resources

attributesobject

idstring

relationshipsobject

typestring

Request

Response

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

const response = await fetch('/api/v1/organization/{organizationId}/template/{templateId}', {
    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}/template', {
    method: 'POST',
    headers: {
      "Content-Type": "application/vnd.api+json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

{
  "data": {
    "type": "text",
    "id": "text",
    "attributes": {
      "createdBy": "text",
      "createdDate": "2024-11-24T01:31:38.734Z",
      "description": "text",
      "name": "text",
      "tcl": "text",
      "updatedBy": "text",
      "updatedDate": "2024-11-24T01:31:38.734Z",
      "version": "text"
    },
    "relationships": {
      "organization": {
        "id": "text",
        "type": "organization"
      }
    }
  }
}

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

{
  "data": {
    "type": "text",
    "id": "text",
    "attributes": {
      "createdBy": "text",
      "createdDate": "2024-11-24T01:31:38.734Z",
      "description": "text",
      "name": "text",
      "tcl": "text",
      "updatedBy": "text",
      "updatedDate": "2024-11-24T01:31:38.734Z",
      "version": "text"
    },
    "relationships": {
      "organization": {
        "id": "text",
        "type": "organization"
      }
    }
  },
  "included": [
    {
      "id": "text",
      "type": "text"
    }
  ]
}