Skip to content

Latest commit

 

History

History
52 lines (40 loc) · 3.75 KB

schedule.md

File metadata and controls

52 lines (40 loc) · 3.75 KB
Raw

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

{% hint style="info" %} To better understand Terrakube Configuration Language job templates please refer to the following GitHub repository. {% endhint %}

Example:

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

Supported Operations

{% swagger src="https://raw.githubusercontent.com/AzBuilder/terrakube-server/main/openapi-spec/v1_6.yml" path="/workspace/{workspaceId}/schedule/{scheduleId}" method="get" %} https://raw.githubusercontent.com/AzBuilder/terrakube-server/main/openapi-spec/v1_6.yml {% endswagger %}

{% swagger src="https://raw.githubusercontent.com/AzBuilder/terrakube-server/main/openapi-spec/v1_6.yml" path="/workspace/{workspaceId}/schedule" method="post" %} https://raw.githubusercontent.com/AzBuilder/terrakube-server/main/openapi-spec/v1_6.yml {% endswagger %}

{% swagger src="https://raw.githubusercontent.com/AzBuilder/terrakube-server/main/openapi-spec/v1_6.yml" path="/workspace/{workspaceId}/schedule/{scheduleId}" method="delete" %} https://raw.githubusercontent.com/AzBuilder/terrakube-server/main/openapi-spec/v1_6.yml {% endswagger %}

{% swagger src="https://raw.githubusercontent.com/AzBuilder/terrakube-server/main/openapi-spec/v1_6.yml" path="/workspace/{workspaceId}/schedule/{scheduleId}" method="patch" %} https://raw.githubusercontent.com/AzBuilder/terrakube-server/main/openapi-spec/v1_6.yml {% endswagger %}

{% hint style="info" %} For a complete list of organization operation please visit the OpenAPI specification {% endhint %}