Template

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

Entity fields:

Path	Type	Description
data.type	string	Should be "template"
data.attributes.tcl	string	Terraform Configuration Language job template
data.attribute.name	string	Template name
data.attribute.description	string	Template description
data.attribute.version	string	Template version

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

get

Returns an instance of type template

Path parameters

organizationIdanyRequired

organization Identifier

templateIdanyRequired

template Identifier

Query parameters

fields[template]anyOptional

Selects the set of template 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

application/vnd.api+json

objectOptional

get

HTTPcURLJavaScriptPython

GET /organization/{organizationId}/template/{templateId} HTTP/1.1
Host: 
Accept: */*

200

Successful response

{
  "data": {
    "type": "text",
    "id": "text",
    "attributes": {
      "createdBy": "text",
      "createdDate": "2025-04-20T17:31:15.071Z",
      "description": "text",
      "name": "text",
      "tcl": "text",
      "updatedBy": "text",
      "updatedDate": "2025-04-20T17:31:15.071Z",
      "version": "text"
    },
    "relationships": {
      "organization": {
        "id": "text",
        "type": "organization"
      }
    }
  },
  "included": [
    {
      "attributes": {},
      "id": "text",
      "relationships": {},
      "type": "text"
    }
  ]
}

post

Creates an item of type template and adds it to template

Path parameters

organizationIdanyRequired

organization Identifier

Body

dataobjectOptional

Responses

application/vnd.api+json

objectOptional

post

HTTPcURLJavaScriptPython

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

{
  "data": {
    "type": "text",
    "id": "text",
    "attributes": {
      "createdBy": "text",
      "createdDate": "2025-04-20T17:31:15.071Z",
      "description": "text",
      "name": "text",
      "tcl": "text",
      "updatedBy": "text",
      "updatedDate": "2025-04-20T17:31:15.071Z",
      "version": "text"
    },
    "relationships": {
      "organization": {
        "id": "text",
        "type": "organization"
      }
    }
  }
}

201

Successful response

{
  "data": {
    "type": "text",
    "id": "text",
    "attributes": {
      "createdBy": "text",
      "createdDate": "2025-04-20T17:31:15.071Z",
      "description": "text",
      "name": "text",
      "tcl": "text",
      "updatedBy": "text",
      "updatedDate": "2025-04-20T17:31:15.071Z",
      "version": "text"
    },
    "relationships": {
      "organization": {
        "id": "text",
        "type": "organization"
      }
    }
  }
}

delete

Deletes an instance of type template

Path parameters

organizationIdanyRequired

organization Identifier

templateIdanyRequired

template Identifier

Responses

delete

HTTPcURLJavaScriptPython

DELETE /organization/{organizationId}/template/{templateId} HTTP/1.1
Host: 
Accept: */*

204

Successful response

No content

patch

Modifies an instance of type template

Path parameters

organizationIdanyRequired

organization Identifier

templateIdanyRequired

template Identifier

Body

dataobjectOptional

Responses

patch

HTTPcURLJavaScriptPython

PATCH /organization/{organizationId}/template/{templateId} HTTP/1.1
Host: 
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 305

{
  "data": {
    "type": "text",
    "id": "text",
    "attributes": {
      "createdBy": "text",
      "createdDate": "2025-04-20T17:31:15.071Z",
      "description": "text",
      "name": "text",
      "tcl": "text",
      "updatedBy": "text",
      "updatedDate": "2025-04-20T17:31:15.071Z",
      "version": "text"
    },
    "relationships": {
      "organization": {
        "id": "text",
        "type": "organization"
      }
    }
  }
}

204

Successful response

No content

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