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 |
---|---|---|
To better understand Terrakube Configuration Language job templates please refer to the following GitHub repository.
For a complete list of organization operation please visit the OpenAPI specification
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)
Deletes an instance of type job
workspace Identifier
job Identifier
Successful response
Modifies an instance of type job
workspace Identifier
job Identifier
Successful response
Creates an item of type job and adds it to job
workspace Identifier
Successful response
Returns an instance of type job
workspace Identifier
job Identifier
Selects the set of job fields that should be returned in the result.
Selects the set of relationships that should be expanded as a compound document in the result.
Successful response
Included resources