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
Responses
200
Successful response
application/vnd.api+json
get
GET /api/v1/organization/{organizationId}/template/{templateId} HTTP/1.1
Host: 
Accept: */*
200

Successful response

{
  "data": {
    "type": "text",
    "id": "text",
    "attributes": {
      "createdBy": "text",
      "createdDate": "2025-07-08T11:16:57.797Z",
      "description": "text",
      "name": "text",
      "tcl": "text",
      "updatedBy": "text",
      "updatedDate": "2025-07-08T11:16:57.797Z",
      "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
Responses
201
Successful response
application/vnd.api+json
post
POST /api/v1/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-07-08T11:16:57.797Z",
      "description": "text",
      "name": "text",
      "tcl": "text",
      "updatedBy": "text",
      "updatedDate": "2025-07-08T11:16:57.797Z",
      "version": "text"
    },
    "relationships": {
      "organization": {
        "id": "text",
        "type": "organization"
      }
    }
  }
}
201

Successful response

{
  "data": {
    "type": "text",
    "id": "text",
    "attributes": {
      "createdBy": "text",
      "createdDate": "2025-07-08T11:16:57.797Z",
      "description": "text",
      "name": "text",
      "tcl": "text",
      "updatedBy": "text",
      "updatedDate": "2025-07-08T11:16:57.797Z",
      "version": "text"
    },
    "relationships": {
      "organization": {
        "id": "text",
        "type": "organization"
      }
    }
  }
}
delete

Deletes an instance of type template

Path parameters
organizationIdanyRequired

organization Identifier

templateIdanyRequired

template Identifier

Responses
204
Successful response
delete
DELETE /api/v1/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
Responses
204
Successful response
patch
PATCH /api/v1/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-07-08T11:16:57.797Z",
      "description": "text",
      "name": "text",
      "tcl": "text",
      "updatedBy": "text",
      "updatedDate": "2025-07-08T11:16:57.797Z",
      "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

PreviousJobsNextSchedule