Schedule

This endpoint is used to create, update, search or delete schedules for a particular workspace inside an organization, this is useful when you need to create schedule task or running jobs in a particular time.

Entity fields:

Path	Type	Description
data.type	string	Should be "template"
data.attributes.cron	string	Cron expression to schedule a job inside a workspace. For more information please visit Quartz documentation.
data.attributes.tcl	string	Terrakube configuration language in base64
data.attributes.templateReference	string	Terrakube template id

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

Example:

{
  "data": {
    "type": "schedule",
    "attributes": {
      "cron": "0 0/1 * * * ?",
      "tcl": "{{templateSample}}"
    }
  }
}

Supported Operations

get

Returns an instance of type schedule

Path parameters

workspaceIdanyRequired

workspace Identifier

scheduleIdanyRequired

schedule Identifier

Query parameters

fields[schedule]anyOptional

Selects the set of schedule 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 /workspace/{workspaceId}/schedule/{scheduleId} HTTP/1.1
Host: 
Accept: */*

200

Successful response

{
  "data": {
    "type": "text",
    "id": "text",
    "attributes": {
      "createdBy": "text",
      "createdDate": "2025-04-20T17:43:56.413Z",
      "cron": "text",
      "description": "text",
      "enabled": true,
      "tcl": "text",
      "updatedBy": "text",
      "updatedDate": "2025-04-20T17:43:56.413Z"
    },
    "relationships": {
      "workspace": {
        "id": "text",
        "type": "workspace"
      }
    }
  },
  "included": [
    {
      "attributes": {},
      "id": "text",
      "relationships": {},
      "type": "text"
    }
  ]
}

post

Creates an item of type schedule and adds it to schedule

Path parameters

workspaceIdanyRequired

workspace Identifier

Body

dataobjectOptional

Responses

application/vnd.api+json

objectOptional

post

HTTPcURLJavaScriptPython

POST /workspace/{workspaceId}/schedule HTTP/1.1
Host: 
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 297

{
  "data": {
    "type": "text",
    "id": "text",
    "attributes": {
      "createdBy": "text",
      "createdDate": "2025-04-20T17:43:56.413Z",
      "cron": "text",
      "description": "text",
      "enabled": true,
      "tcl": "text",
      "updatedBy": "text",
      "updatedDate": "2025-04-20T17:43:56.413Z"
    },
    "relationships": {
      "workspace": {
        "id": "text",
        "type": "workspace"
      }
    }
  }
}

201

Successful response

{
  "data": {
    "type": "text",
    "id": "text",
    "attributes": {
      "createdBy": "text",
      "createdDate": "2025-04-20T17:43:56.413Z",
      "cron": "text",
      "description": "text",
      "enabled": true,
      "tcl": "text",
      "updatedBy": "text",
      "updatedDate": "2025-04-20T17:43:56.413Z"
    },
    "relationships": {
      "workspace": {
        "id": "text",
        "type": "workspace"
      }
    }
  }
}

delete

Deletes an instance of type schedule

Path parameters

workspaceIdanyRequired

workspace Identifier

scheduleIdanyRequired

schedule Identifier

Responses

delete

HTTPcURLJavaScriptPython

DELETE /workspace/{workspaceId}/schedule/{scheduleId} HTTP/1.1
Host: 
Accept: */*

204

Successful response

No content

patch

Modifies an instance of type schedule

Path parameters

workspaceIdanyRequired

workspace Identifier

scheduleIdanyRequired

schedule Identifier

Body

dataobjectOptional

Responses

patch

HTTPcURLJavaScriptPython

PATCH /workspace/{workspaceId}/schedule/{scheduleId} HTTP/1.1
Host: 
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 297

{
  "data": {
    "type": "text",
    "id": "text",
    "attributes": {
      "createdBy": "text",
      "createdDate": "2025-04-20T17:43:56.413Z",
      "cron": "text",
      "description": "text",
      "enabled": true,
      "tcl": "text",
      "updatedBy": "text",
      "updatedDate": "2025-04-20T17:43:56.413Z"
    },
    "relationships": {
      "workspace": {
        "id": "text",
        "type": "workspace"
      }
    }
  }
}

204

Successful response

No content

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