Comment on page

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
/workspace/{workspaceId}/schedule/{scheduleId}
post
/workspace/{workspaceId}/schedule
delete
/workspace/{workspaceId}/schedule/{scheduleId}
patch
/workspace/{workspaceId}/schedule/{scheduleId}
For a complete list of organization operation please visit the OpenAPI specification​

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

Template

Step

Last modified 1yr ago