Skip to main content
POST
The body is optional. Omit it, or send "force": false, for a graceful stop. "force": true cancels immediately.

Authorizations

Authorization
string
header
required

Requires an API key. See the Authentication guide.

Path Parameters

task_id
string
required

Body

application/json

Omit the body for a graceful cancel.

force
boolean
default:false

Response

200 - application/json

Cancel accepted.

id
string
required
status
string
required
Allowed value: "cancelled"
type
string
default:task_status
Allowed value: "task_status"