GEgetorchestra
Pipelines

Get a pipeline by selector

Changed on

Retrieve a single pipeline by selector. Provide only one selector: pipeline_id, alias, or the pair repository and yaml_path.

get/pipeline

Request

  • Base URL
    https://app.getorchestra.io/api/engine/public
  • URL
    https://app.getorchestra.io/api/engine/public/pipeline
  • 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

Query parameters

pipeline_idstring uuid4 nullable

Pipeline ID selector.

aliasstring nullable

Pipeline alias selector.

repositorystring nullable

Repository selector. Must be provided together with yaml_path.

yaml_pathstring nullable

Pipeline YAML path selector. Must be provided together with repository.

versioninteger nullable

Pipeline version selector (used for versioned pipeline YAML).

branchstring nullable

Pipeline branch selector (used for git-backed pipeline YAML).

commitstring nullable

Pipeline commit selector (used for git-backed pipeline YAML).

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
namestring required
numTasksinteger nullable
yamlPathstring required
createdAtstring required
updatedAtstring required
pausedboolean required
triggerEventsstring nullable
webhookstring nullable
schedulestring nullable
sensorsstring nullable
inputsobject nullable
productIdstring uuid4 nullable
productNamestring nullable
latestVersionNumberinteger nullable
publishedVersionNumberinteger nullable
storageProviderstring nullable
repositorystring nullable
defaultBranchstring nullable
aliasstring nullable
folderstring nullable
latestRunIdstring uuid4 nullable
latestRunStatus'QUEUED' | 'CREATED' | 'RUNNING' | 'SUCCEEDED' | 'WARNING' | 'FAILED' | 'SKIPPED' | 'CANCELLING' | 'CANCELLED'
latestRunMessagestring nullable
latestRunCreatedAtstring nullable
latestRunCompletedAtstring nullable
latestRunStartedAtstring nullable

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

    • info

      added the optional property to the response with the status

    • info

      added the optional property /// to the response with the status