Jobs

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.

Status of the most recent run.

namestring required

Job name.

updated_atstring date-time nullable

When the job was last updated.

Changes

Changed in 4 of the 55 revisions of this API.6125

Aug 17, 202622c2a22911462See the full diff
- ○
  added the new optional request property //
  new-optional-request-property
- ○
  added the optional property // to the response with the status
  response-optional-property-added
This revision also has 104 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 20, 2026d4e4f170f4f43113See the full diff
- ▲
  removed from the request property anyOf list
  request-property-any-of-removed
- ▲
  removed from the request property anyOf list
  request-property-any-of-removed
- ▲
  removed from the request property anyOf list
  request-property-any-of-removed
- ●
  deleted the cookie request parameter token
  request-parameter-removed
- ○
  api operation id update_job_v2_jobs__job_id__patch removed and replaced with update_job_public_v1_api_v1_public_jobs__job_id__patch
  api-operation-id-removed
- ○
  the endpoint scheme security APIKeyCookie was added to the API
  api-security-added
- ○
  the endpoint scheme security HTTPBearer was added to the API
  api-security-added
- ○
  endpoint deprecated
  endpoint-deprecated
- ○
  added to the request property anyOf list
  request-property-any-of-added
- ○
  added to the request property anyOf list
  request-property-any-of-added
- ○
  added to the request property anyOf list
  request-property-any-of-added
- ○
  added to the response property anyOf list for the response status
  response-property-any-of-added
- ○
  added to the response property anyOf list for the response status
  response-property-any-of-added
- ○
  added to the response property anyOf list for the response status
  response-property-any-of-added
- ○
  removed from the response property anyOf list for the response status
  response-property-any-of-removed
- ○
  removed from the response property anyOf list for the response status
  response-property-any-of-removed
- ○
  removed from the response property anyOf list for the response status
  response-property-any-of-removed
This revision also has 36 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 12, 2026e8a97dc9fce239See the full diff
- ▲
  removed from the request property anyOf list
  request-property-any-of-removed
- ▲
  removed from the request property anyOf list
  request-property-any-of-removed
- ▲
  removed from the request property anyOf list
  request-property-any-of-removed
- ○
  added to the request property anyOf list
  request-property-any-of-added
- ○
  added to the request property anyOf list
  request-property-any-of-added
- ○
  added to the request property anyOf list
  request-property-any-of-added
- ○
  added to the response property anyOf list for the response status
  response-property-any-of-added
- ○
  added to the response property anyOf list for the response status
  response-property-any-of-added
- ○
  added to the response property anyOf list for the response status
  response-property-any-of-added
- ○
  removed from the response property anyOf list for the response status
  response-property-any-of-removed
- ○
  removed from the response property anyOf list for the response status
  response-property-any-of-removed
- ○
  removed from the response property anyOf list for the response status
  response-property-any-of-removed
This revision also has 39 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jun 18, 20262562e655b8f21See the full diff
- ○
  endpoint added
  endpoint-added

Full history