The following operation is supported on this resource:

  • POST - Cancel a scheduled job
POST /jobs/{id}/cancel Version 1

This API is used to cancel a job specified by job ID. Only top-level jobs can be canceled (i.e. sub-jobs cannot be canceled). A job can be canceled only if it is scheduled to run in the future and has not yet started. Running or completed jobs cannot be canceled.

Sample Usage

POST /jobs/{id}/cancel

  • Parameters:
    Name Type URI Type Description Required
    job-instance-id Integer Path The ID of the job instance to cancel. Y

Access Control

The following capabilities are required to access this API: CancelJob