Jobs Cancel Create

post

/api/v2/jobs/{id}/cancel/

Cancel a Job

Make a POST request to this resource to cancel a pending or running job. The response status code will be 202 if successful, or 405 if the job cannot be canceled.

Request

Supported Media Types

application/json

Path Parameters

id(required): string

Root Schema : JobCancel

Type: object

Show Source

can_cancel: boolean

Title: Can cancel

Read Only: true

{
    "properties":{
        "can_cancel":{
            "readOnly":true,
            "title":"Can cancel",
            "type":"boolean"
        }
    },
    "type":"object"
}

Response

Supported Media Types

application/json

201 Response

Root Schema : JobCancel

Type: object

Show Source

can_cancel: boolean

Title: Can cancel

Read Only: true

{
    "properties":{
        "can_cancel":{
            "readOnly":true,
            "title":"Can cancel",
            "type":"boolean"
        }
    },
    "type":"object"
}