NInimbleway
Jobs

Update Job

Changed on

Update Job

patch/v1/jobs/{job_id}

Request

  • Base URL
    https://sdk.nimbleway.com
  • URL
    https://sdk.nimbleway.com/v1/jobs/{job_id}
  • Auth
    • HTTP bearer
    • or API key in cookie token

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.

Changes

  • 22c2a2291146Revision changes
    • info

      added the new optional request property //

    • info

      added the optional property // to the response with the status

  • d4e4f170f4f4Revision changes
    • breaking

      removed from the request property anyOf list

    • breaking

      removed from the request property anyOf list

    • breaking

      removed from the request property anyOf list

    • warning

      deleted the cookie request parameter token

    • info

      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

    • info

      the endpoint scheme security APIKeyCookie was added to the API

    • info

      the endpoint scheme security HTTPBearer was added to the API

    • info

      endpoint deprecated

    • info

      added to the request property anyOf list

    • info

      added to the request property anyOf list

    • info

      added to the request property anyOf list

    • info

      added to the response property anyOf list for the response status

    • info

      added to the response property anyOf list for the response status

    • info

      added to the response property anyOf list for the response status

    • info

      removed from the response property anyOf list for the response status

    • info

      removed from the response property anyOf list for the response status

    • info

      removed from the response property anyOf list for the response status