v50

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-011235801.3 MB
Jobs

Update Job

Update Job

patch/v1/jobs/{job_id}

Path parameters

job_idstring required

Request body

descriptionstring nullable

New description.

display_namestring nullable

New display name.

Response

Successful Response

agent_namestring nullable

Name of the agent this job runs.

created_atstring date-time nullable

When the job was created.

descriptionstring nullable

Free-text description of the job.

display_namestring nullable

Human-friendly job name shown in the UI.

idstring required

Unique job identifier (job_<n>).

last_run_atstring date-time nullable

Timestamp of the most recent run.

last_run_status'PENDING' | 'RUNNING' | 'SUCCESS' | 'FAILED' | 'CANCELLED' | 'TIMEOUT' | 'WARNING' nullable

Status of the most recent run.

namestring required

Job name.

updated_atstring date-time nullable

When the job was last updated.