Cancel a task

DELETE 
/v1/task/:task_id

Cancel a task.

Request

Path Parameters

task_id Task Idrequired

Responses

204

The task was successfully cancelled.

403

The user is not authorized to perform this action.

application/json

Schema

Schema

any

Example (from schema)

{
  "status_code": 403,
  "detail": "The user is not authorized to perform this action."
}

Example

{
  "status_code": 403,
  "detail": "The user is not authorized to perform this action."
}

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

501

An attempt was made to cancel a task that is not a parse task.

application/json

Schema

Schema

any

Example (from schema)

{
  "status_code": 501,
  "detail": "Cancellation only implemented for parse tasks."
}

Example

{
  "status_code": 501,
  "detail": "Cancellation only implemented for parse tasks."
}

Loading...