Documentation by ClonePartner

Start typing to search.

API Reference

Start a job run

View Markdown
POST /api/jobs/{id}/run

Creates a new job run and begins DAG execution using the job's snapshotted template YAML and pinned task versions (captured at job creation time). Optionally specify a subset of tasks to run.

Operation IDrunJob

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

Content typeapplication/json

requestobject
2 properties
tasksarray<string>

Subset of task keys to run (omit to run all)

Array items
itemstring
skip_depsboolean

When true and tasks is a non-empty array, run only the selected task keys without expanding their upstream depends_on tasks. Ignored when tasks is omitted or empty. Stored on the job run so resume behaves identically.

Success response body

201Job run created and started

Job run created and started

Content typeapplication/json

responseobject
12 properties
idinteger
job_idinteger
statusstring
Allowed values
pending, running, paused, completed, failed, cancelled
started_atstring | null · date-time
Nullable
yes
completed_atstring | null · date-time
Nullable
yes
duration_msinteger | null
Nullable
yes
error_messagestring | null
Nullable
yes
selected_tasksstring | null

JSON-encoded array of task keys to run (null = all)

Nullable
yes
run_statestring | null

Internal DAG execution state (JSON)

Nullable
yes
skip_depsinteger | null

1 when selected tasks should run without their upstream depends_on tasks; 0/null otherwise.

Nullable
yes
created_atstring · date-time
updated_atstring · date-time

Error responses

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"
}