Change a Job's state

Changes a Job's state. State values: not_ready, ready, scheduled, running, succeeded, failed, disabled, cancelled and deleted. Values are case-insensitive, so not_ready and NotReady are equivalent. Repeating a request for the Job's current state succeeds without changing it. Which states you can request depends on the Job's current state and type; see Job State Management.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The pipeline ID.

string
required

The Ingress Component (step) ID.

string
required

The Job ID.

string
required

The state to move the Job to, for example cancelled.

Responses

401

Unauthorized. The apikey header is missing or the key is wrong.

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json