Jobs

This endpoint is used to create, update, search or delete jobs for a particular Terrakube workspace.

To use this endpoint you need to create a Terrakube workspace.

Entity fields:

Path

Type

Description

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

Example:

{
  "data": {
    "type": "job",
    "attributes": {
      "tcl": "Base64 TCL job template"
      "templateReference": "XXXXXXXXX"
    },
    "relationships":{
        "workspace":{
            "data":{
                "type": "workspace",
                "id": "{{workspaceId}}"
            }
        }
    }
  }
}

Supported Operations

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

PreviousHistory NextTemplate

Last updated 11 months ago

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

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

{
  "data": {
    "type": "text",
    "id": "text",
    "attributes": {
      "command": "plan",
      "output": "text",
      "status": "pending"
    },
    "relationships": {
      "organization": {
        "id": "text",
        "type": "organization"
      },
      "workspace": {
        "id": "text",
        "type": "workspace"
      }
    }
  }
}

{
  "data": {
    "type": "text",
    "id": "text",
    "attributes": {
      "command": "plan",
      "output": "text",
      "status": "pending"
    },
    "relationships": {
      "organization": {
        "id": "text",
        "type": "organization"
      },
      "workspace": {
        "id": "text",
        "type": "workspace"
      }
    }
  },
  "included": [
    {
      "id": "text",
      "type": "text"
    }
  ]
}