Sign in
Jobs

Create Job

Create Job

post/v1/jobs

Request body

agent_namestring required

Name of the agent to run.

descriptionstring nullable

Free-text description of the job.

display_namestring nullable

Human-friendly job name shown in the UI.

namestring required

Job 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.

Changes

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

  • 22c2a22911462See the full diff
    • ○

      added the new optional request property inputs/anyOf[subschema #1: JobInputsPublicV1]/node_data

      new-optional-request-property

    • ○

      added the optional property inputs/anyOf[subschema #1: JobInputsPublicV1]/node_data to the response with the 201 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

  • d4e4f170f4f43113See the full diff
    • ▲

      removed CrustJobDestination from the destination request property anyOf list

      request-property-any-of-removed

    • ▲

      removed CrustJobInputs from the inputs request property anyOf list

      request-property-any-of-removed

    • ▲

      removed CrustJobSchedule from the schedule request property anyOf list

      request-property-any-of-removed

    • ●

      deleted the cookie request parameter token

      request-parameter-removed

    • ○

      api operation id create_job_v2_jobs_post removed and replaced with create_job_public_v1_api_v1_public_jobs_post

      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 JobDestinationPublicV1 to the destination request property anyOf list

      request-property-any-of-added

    • ○

      added JobInputsPublicV1 to the inputs request property anyOf list

      request-property-any-of-added

    • ○

      added JobSchedulePublicV1 to the schedule request property anyOf list

      request-property-any-of-added

    • ○

      added JobDestinationPublicV1 to the destination response property anyOf list for the response status 201

      response-property-any-of-added

    • ○

      added JobInputsPublicV1 to the inputs response property anyOf list for the response status 201

      response-property-any-of-added

    • ○

      added JobSchedulePublicV1 to the schedule response property anyOf list for the response status 201

      response-property-any-of-added

    • ○

      removed CrustJobDestination from the destination response property anyOf list for the response status 201

      response-property-any-of-removed

    • ○

      removed CrustJobInputs from the inputs response property anyOf list for the response status 201

      response-property-any-of-removed

    • ○

      removed CrustJobSchedule from the schedule response property anyOf list for the response status 201

      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

  • e8a97dc9fce239See the full diff
    • ▲

      removed JobDestination from the destination request property anyOf list

      request-property-any-of-removed

    • ▲

      removed JobInputs from the inputs request property anyOf list

      request-property-any-of-removed

    • ▲

      removed JobSchedule from the schedule request property anyOf list

      request-property-any-of-removed

    • ○

      added CrustJobDestination to the destination request property anyOf list

      request-property-any-of-added

    • ○

      added CrustJobInputs to the inputs request property anyOf list

      request-property-any-of-added

    • ○

      added CrustJobSchedule to the schedule request property anyOf list

      request-property-any-of-added

    • ○

      added CrustJobDestination to the destination response property anyOf list for the response status 201

      response-property-any-of-added

    • ○

      added CrustJobInputs to the inputs response property anyOf list for the response status 201

      response-property-any-of-added

    • ○

      added CrustJobSchedule to the schedule response property anyOf list for the response status 201

      response-property-any-of-added

    • ○

      removed JobDestination from the destination response property anyOf list for the response status 201

      response-property-any-of-removed

    • ○

      removed JobInputs from the inputs response property anyOf list for the response status 201

      response-property-any-of-removed

    • ○

      removed JobSchedule from the schedule response property anyOf list for the response status 201

      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

  • 2562e655b8f21See the full diff
    • ○

      endpoint added

      endpoint-added