Cancel Workflow Job
post
/api/v2/workflow_jobs/{id}/cancel/
Make a GET request to this resource to determine if the workflow job can be canceled. The response will include the following field:
can_cancel
: Indicates whether this workflow job is in a state that can be canceled (boolean, read-only)
Make a POST request to this endpoint to submit a request to cancel a pending or running workflow job. The response status code will be 202 if the request to cancel was successfully submitted, or 405 if the workflow job cannot be canceled.
Request
Supported Media Types
- application/json
Path Parameters
Root Schema : WorkflowJobCancel
Type:
Show Source
object
-
can_cancel:
boolean
Title:
Can cancel
Read Only:true
Response
Supported Media Types
- application/json
201 Response
Root Schema : WorkflowJobCancel
Type:
Show Source
object
-
can_cancel:
boolean
Title:
Can cancel
Read Only:true