Abort Background Task

curl --request PUT \
  --url https://{api_endpoint}/api/v1/tasks/{task_id}/abort \
  --header 'Authorization: Bearer <token>'

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

curl --request PUT \
  --url https://{api_endpoint}/api/v1/tasks/{task_id}/abort \
  --header 'Authorization: Bearer <token>'

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

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

task_id

string

required

Successful Response

Documentation Index