Cancel a task

Cancel a running or queued task. Returns 202 Accepted for async cancellation, 409 if task is already in terminal state, 404 if not found.

post/api/v1/tasks/{id}/cancel

Request

  • Base URL: http://localhost:8080
  • URL: http://localhost:8080/api/v1/tasks/{id}/cancel
  • Auth: API key in header X-API-Key

Path parameters

idstring required

Task ID

Request body

reasonstring

Optional reason for cancellation

Response

Cancellation accepted

messagestring

Status message

statusstring

Current task status (included in 409 response)

successboolean

Whether the cancellation was successful

Changes

No recorded changes to this operation across all 1 revision of this API.