runs

Cancel Run

Cancel a queued or running run owned by the caller.

post/api/runs/{run_id}/cancel

Request

  • Base URL: https://api.retirementlab.app (the document declares no server; this is the origin it was published from)
  • URL: https://api.retirementlab.app/api/runs/{run_id}/cancel
  • Auth: HTTP bearer

Path parameters

run_idinteger required

Request body

idempotency_keystring

Response

Successful Response

run_idinteger required
status'cancelled' required
idempotency_keystring
assumptions_versionstring
assumptions_version_state'declared' | 'legacy_unverified'

Changes

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