Jobs
Cancels given Job.
Calling this endpoint will return immediately and not wait until the Job is actually stopped. Users can cancel their own jobs and Admins can cancel any job. This endpoint will be removed in 2026.06. Please use DELETE /rest/jobs/v1/jobs/:jobId
post/jobs/{jobId}/canceled
Request
- Base URL/rest/2.0 (relative, and the document’s source URL is not known)
- Auth
- HTTP basic
- or HTTP bearer
- or OAuth 2Client credentialsToken URL/rest/oauth/v2/tokenScopessys.admin
- or OAuth 2Client credentialsToken URL/rest/oauth/v2/token
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
jobIdstring uuid required
The unique identifier of the Job.
Request body
Response
Job cancellation accepted.
Changes
No recorded changes to this operation across all 1 revision of this API.