Job Management API

/api/space/job-management/jobs/{id}/cancel

The following operations are supported on this resource:

POST /api/space/job-management/jobs/{id}/cancel (v1)


This API is used to cancel a job specified by job ID. Only root jobs can be cancelled. A job can be cancelled only if it is scheduled to run in the future and has not yet started. Running or completed jobs cannot be canceled.

Access Control

The following capabilities are required to access this API:
"CancelJob"


Example Usage

POST /api/space/job-management/jobs/{id}/cancel


Parameters

NameTypeURI TypeDescriptionRequired
job-instance-idIntegerPathThe ID of the job instance to cancel. Y