GEgetorchestra
Pipeline Runs

Cancel a pipeline run

Changed on

Cancel a pipeline run. Call this without a body (or with force: false) first — that moves the run to CANCELLING. Only pass force: true on a follow-up call if the run is still stuck in CANCELLING; otherwise the request is rejected with 400.

post/pipeline_runs/{pipeline_run_id}/cancel

Request

  • Base URL
    https://app.getorchestra.io/api/engine/public
  • URL
    https://app.getorchestra.io/api/engine/public/pipeline_runs/{pipeline_run_id}/cancel
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://app.getorchestra.io/oauth/authorize
      Token URL: https://app.getorchestra.io/oauth/token scopes: orchestra:write

Path parameters

pipeline_run_idstring uuid4 required

Pipeline run ID.

Headers

X-Orchestra-Account-Idstring uuid4 nullable

Act on this account rather than the one the credential resolves to. Omit it to use the credential's own account. An API key is issued to a single account, so it may only name that account; an OAuth token may name any account its grant covers.

Request body

forceboolean

Force-cancel a run already stuck in 'CANCELLING'. Do not send this on the first cancel call — the run must already be 'CANCELLING', or the request is rejected with 400.

Response

Operation completed successfully. Empty response body.

Changes

  • e45165e7e223Revision changes
    • info

      the endpoint scheme security ApiKey was added to the API

    • info

      the endpoint scheme security OAuth was added to the API

    • info

      the endpoint scheme security BearerAuth was removed from the API

    • info

      added the new optional header request parameter X-Orchestra-Account-Id