Sign in
Runs

Abort an in-progress Run with a reason

Changed on

Bearer run:execute (or cookie session); member+ write access. Transactional abort via one SECURITY DEFINER RPC: closes the Run as aborted (sets finished_at, records the reason, bumps version), marks every not-yet-executed step skipped, and preserves already-recorded step results. Only a running Run can be aborted — an already-closed Run returns 409. The reason is trimmed then required to be 3..500 characters. Abort is first-wins: a concurrent double-submit serializes on a row lock and the loser gets 409.

post/api/v1/runs/{id}/abort

Request

  • Base URL: http://localhost:3000
  • URL: http://localhost:3000/api/v1/runs/{id}/abort
  • Auth: one of:
    • API key in cookie sb-fmbpikzpkafptqximhxn-auth-token
    • HTTP bearer

Path parameters

idstring uuid required

Request body

reasonstring required

Why the run is being aborted. Trimmed, then required to be 3..500 characters.

Response

Run aborted. Returns the updated Run with status: aborted and abort_reason.

Changes

  • 4528999528c6Revision changes
    • warning

      added the new test_outside_plan_project enum value to the / response property for the response status

    • warning

      added the new test_outside_plan_project enum value to the / response property for the response status

    • warning

      added the new test_outside_plan_project enum value to the / response property for the response status

    • warning

      added the new test_outside_plan_project enum value to the / response property for the response status

    • warning

      added the new test_outside_plan_project enum value to the / response property for the response status

  • 2ca74ff5fec5Revision changes
    • info

      removed the test_outside_plan_project enum value from the / response property for the response status

    • info

      removed the test_outside_plan_project enum value from the / response property for the response status

    • info

      removed the test_outside_plan_project enum value from the / response property for the response status

    • info

      removed the test_outside_plan_project enum value from the / response property for the response status

    • info

      removed the test_outside_plan_project enum value from the / response property for the response status