GEgetorchestra
Pipeline Runs

Get pipeline run status

Changed on

Retrieve status details for a single pipeline run.

get/pipeline_runs/{pipeline_run_id}/status

Request

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

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.

Response

Successful response.

idstring uuid4 required
pipelineIdstring uuid4 required
pipelineNamestring required
runStatus'QUEUED' | 'CREATED' | 'RUNNING' | 'SUCCEEDED' | 'WARNING' | 'FAILED' | 'SKIPPED' | 'CANCELLING' | 'CANCELLED' required

Changes

  • e45165e7e223Revision changes
    • warning

      added the new QUEUED enum value to the response property for the response status

    • info

      the endpoint scheme security BearerAuthReadOnly was removed from the API

    • info

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