GEgetorchestra
Pipelines

List pipelines

Changed on

List pipelines for the workspace the credential resolves to.

Always pass page and page_size to receive a paginated response with page, page_size, total, and results fields, sorted by pipeline name. Use name to filter pipelines by a case-insensitive substring match on the pipeline name.

get/pipelines

Request

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

pageinteger nullable

Page number. Must be greater than or equal to 1.

page_sizeinteger nullable

Number of items per page. Defaults to 50; maximum 100.

namestring nullable

Filter by a case-insensitive substring match on the pipeline name.

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