Documentation by ClonePartner

Start typing to search.

API Reference

Create a job from a template

View Markdown
POST /api/job-templates/{id}/jobs

Instantiates a job by snapshotting the template's current YAML and pinning each referenced task to its current DB version. The job is then independent of future changes to the template or tasks.

Validates that: - All required connectors are mapped and types match. - All tasks referenced in the template DAG exist in the database.

Operation IDcreateJobFromTemplate

Authentication

  • BearerAuth·http bearer·API key token (envoy_<hex>). Create keys from Settings → API Keys — see Using the API.

Path parameters

idintegerrequired

Resource ID

Request body

This request body is required.

Content typeapplication/json

requestobject
3 properties
namestringrequired
descriptionstring
connector_mappingobjectrequired

Map of template connector name to connector ID

Additional properties
valueinteger

Success response body

201Job created

Job created

Content typeapplication/json

responseobject
9 properties
idinteger
job_template_idinteger
namestring
descriptionstring | null
Nullable
yes
connector_mappingstring

JSON-encoded map of template connector name to connector ID

statusstring
Allowed values
active, archived
overridden_task_keysarray<string>

DAG node keys with a per-job task YAML override. Present on GET detail.

Array items
itemstring
created_atstring · date-time
updated_atstring · date-time

Error responses

400Validation error

Validation error

Content typeapplication/json

responseobject
2 properties
errorstring
Example
NOT_FOUND
messagestring
Example
Resource not found
Example response
{
  "error": "VALIDATION_ERROR",
  "message": "Invalid input"
}

404Resource not found

Resource not found

Content typeapplication/json

responseobject
2 properties
errorstring
Example
NOT_FOUND
messagestring
Example
Resource not found
Example response
{
  "error": "NOT_FOUND",
  "message": "Resource not found"
}