Trigger a job run

POST

/api/v1/jobs/{job_id}/trigger

curl --request POST \
  --url https://example.com/api/v1/jobs/1/trigger

Parameters

Path Parameters

job_id

required

Job Id

integer

Header Parameters

X-Environment-Id

Any of:

string

string

null

null

Responses

200

Successful Response

Media typeapplication/json

JobRunResponse

Response model for complete job run information (with all task details).

object

run_name

Any of:

string

string

null

null

state

Any of:

string

string

null

null

result_state

Any of:

string

string

null

null

run_id

required

Run Id

integer

job_id

required

Job Id

integer

original_attempt_run_id

Any of:

integer

integer

null

null

life_cycle_state

Any of:

string

string

null

null

start_time

Any of:

string

string format: date-time

null

null

end_time

Any of:

string

string format: date-time

null

null

execution_duration

Any of:

integer

integer

null

null

setup_duration

Any of:

integer

integer

null

null

cleanup_duration

Any of:

integer

integer

null

null

trigger

Any of:

string

string

null

null

run_page_url

Any of:

string

string

null

null

error_message

Any of:

string

string

null

null

created_time

Any of:

string

string format: date-time

null

null

tasks

Any of:

Array<object>

Array<object>

TaskRunResult

Task execution result within a job run.

object

task_key

required

Task Key

string

task_run_id

Any of:

integer

integer

null

null

task_type

Any of:

string

string

null

null

state

Any of:

string

string

null

null

error_message

Any of:

string

string

null

null

start_time

Any of:

string

string format: date-time

null

null

end_time

Any of:

string

string format: date-time

null

null

duration_ms

Any of:

integer

integer

null

null

task_config

Any of:

object

object

key

additional properties

any

null

null

description

Any of:

string

string

null

null

environment_key

Any of:

string

string

null

null

null

null

Example^generated

{
  "run_name": "example",
  "state": "example",
  "result_state": "example",
  "run_id": 1,
  "job_id": 1,
  "original_attempt_run_id": 1,
  "life_cycle_state": "example",
  "start_time": "2026-04-15T12:00:00Z",
  "end_time": "2026-04-15T12:00:00Z",
  "execution_duration": 1,
  "setup_duration": 1,
  "cleanup_duration": 1,
  "trigger": "example",
  "run_page_url": "example",
  "error_message": "example",
  "created_time": "2026-04-15T12:00:00Z",
  "tasks": [
    {
      "task_key": "example",
      "task_run_id": 1,
      "task_type": "example",
      "state": "example",
      "error_message": "example",
      "start_time": "2026-04-15T12:00:00Z",
      "end_time": "2026-04-15T12:00:00Z",
      "duration_ms": 1,
      "task_config": {},
      "description": "example",
      "environment_key": "example"
    }
  ]
}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Example^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}