runs

Cancel a job run

post/runs/{run_id}/cancel

Request

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

Path parameters

run_idstring required

Response

Successful Response

idstring required
createTimestring date-time required
updateTimestring date-time required
namestring required
status'PENDING' | 'RUNNING' | 'FAILED' | 'COMPLETED' | 'CANCELLED' | 'TIMED_OUT' required
startTimestring date-time nullable
completeTimestring date-time nullable

Changes

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