Runs

Cancel a run

Ends an active run without an outcome and writes run.cancelled. A run that has already ended answers 409. Needs rig.run.

post/v1/runs/{runId}/cancel

Request

  • Base URL: https://api.ironfang.com/rig
  • URL: https://api.ironfang.com/rig/v1/runs/{runId}/cancel
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Request body

reasonstring

Response

The cancelled run

Changes

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