Dispatch

Cancel a task

Cancel an in-flight build or revision task. Only tasks in a non-terminal state (queued, running, needs_input) can be cancelled.

post/dispatch/tasks/{task_id}/cancel

Request

  • Base URL
    https://api.parse.bot
  • URL
    https://api.parse.bot/dispatch/tasks/{task_id}/cancel
  • Auth
    API key in header X-API-Key

Path parameters

task_idstring required

Response

Cancellation result

task_idstring
previous_statusstring
cancelledboolean

Changes

No recorded changes to this operation across all 2 revisions of this API.