Comment on page
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.
Path | Type | Description |
---|---|---|
data.type | string | Should be "job" |
data.attributes.tcl | string | Terraform Configuration Language job template |
data.attributes.templateReference | string | Terrakube template id to use when running the job |
data.relationships.workspace.data.type | string | Should be "workspace" |
data.relationships.workspace.data.Id | string | Should be the VCS Workspace Id (OPTIONAL) |
To better understand Terrakube Configuration Language job templates please refer to the following GitHub repository.
{
"data": {
"type": "job",
"attributes": {
"tcl": "Base64 TCL job template"
"templateReference": "XXXXXXXXX"
},
"relationships":{
"workspace":{
"data":{
"type": "workspace",
"id": "{{workspaceId}}"
}
}
}
}
}
get
/workspace/{workspaceId}/job/{jobId}
post
/workspace/{workspaceId}/job
delete
/workspace/{workspaceId}/job/{jobId}
patch
/workspace/{workspaceId}/job/{jobId}
Last modified 1yr ago