task-runs

Cancel a task run

Request cancellation of a task run.

Only a run the caller's organization owns can be cancelled: any other is 404, the same answer as a run that does not exist, and nothing is touched. A run that has already finished is 409: there is nothing left to cancel.

Accepted, not done: the run reads CANCELLING at once and CANCELLED once the backend confirms. A run not yet launched is kept from starting. Safe to send again while the run is CANCELLING.

post/task-runs/{taskRunId}/cancel

Request

  • Base URL: https://api.cloud.wherobots.com
  • URL: https://api.cloud.wherobots.com/task-runs/{taskRunId}/cancel
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

taskRunIdstring required

The id of the task run.

Response

The cancel was accepted: a run still going reads CANCELLING until the backend confirms it CANCELLED. Also returned for a repeat of a cancel still pending, which is dispatched again, and for a run with nothing to stop yet (its state reads UNKNOWN), which is left as it is

unknown required

Changes

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