Create and run a job instance

This operation enables you to create a job instance if one is not currently running. The job instance created runs on an immediate single-run schedule. If there is a current job instance and the "requested_status" parameter is given, then the system attempts to change the status of the current job instance to the requested status.

NOTE: This status change is not guaranteed as there may be occasions where the requested status is invalid, e.g. setting the status of a running job instance to "suspended". The client should poll the current job instance with a GET to determine whether the requested state has been achieved.

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

The ID number of the desired Job resource.

Body Params

Holds the information to update a current job instance.

string
enum

The desired status for the currently running job instance.

Allowed:
Responses

400

BadRequestResponse indicates a request with invalid parameters.

401

UnauthorizedResponse signals an unauthorized API access.

403

ForbiddenResponse signals a request for a resource that does not exist or is not authorized.

500

GenericError generic error.

Language
LoadingLoading…
Response
Choose an example:
application/json