GEgetorchestra
Pipelines

Get pipeline data

Changed on

Fetch the full pipeline definition for a pipeline selected by pipeline_id or alias. Optionally specify a version, branch, or commit to load a specific revision.

get/pipelines/data

Request

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

version'v1' required

Pipeline schema version. Currently only 'v1' is supported.

namestring required

Unique identifier for this pipeline (max 100 chars). Used in UI and API.

pipelineobject required

Dictionary mapping user-chosen IDs to task group or standalone task definitions. IDs must be unique across the entire pipeline and are referenced in dependsOn arrays. Task groups (recommended) are the primary mechanism for building DAGs -- dependencies between groups define execution order.

sensorsobject nullable

Dictionary of sensor definitions that trigger this pipeline. Triggers use OR-logic -- any single trigger firing starts a pipeline run.

inputsobject nullable

Declared inputs that can be passed when triggering the pipeline. Reference in tasks using ${{ inputs.<name> }}. Non-optional inputs without defaults must appear in all trigger runInputs.

metaobject nullable

Changes

  • daf2c16b3057Revision changes
    • warning

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

    • warning

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

  • e45165e7e223Revision changes
    • breaking

      added to the // response property oneOf list for the response status

    • breaking

      added to the /////// response property oneOf list for the response status

    • breaking

      added to the ///// response property oneOf list for the response status

    • breaking

      the // response's property type changed from object to no type for status

    • breaking

      the /////// response's property type changed from object to no type for status

    • breaking

      the ///// response's property type changed from object to no type for status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property //////// from the response with the status

    • warning

      removed the optional property //////// from the response with the status

    • warning

      removed the optional property //////// from the response with the status

    • warning

      removed the optional property ////// from the response with the status

    • warning

      removed the optional property ////// from the response with the status

    • warning

      removed the optional property ////// from the response with the status

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

      added the new TYPESAFE_JEV_EVALUATE 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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

      added to the //// response property anyOf list for the response status

    • info

      added to the // response property anyOf list for the response status

    • info

      added to the ///////// response property anyOf list for the response status

    • info

      added to the /////// response property anyOf list for the response status

    • info

      added to the /////// response property anyOf list for the response status

    • info

      added to the ///// response property anyOf list for the response status

    • info

      removed subschema #1 from the //// response property anyOf list for the response status

    • info

      removed subschema #1 from the // response property anyOf list for the response status

    • info

      removed subschema #1 from the ///////// response property anyOf list for the response status

    • info

      removed subschema #1 from the /////// response property anyOf list for the response status

    • info

      removed subschema #1 from the /////// response property anyOf list for the response status

    • info

      removed subschema #1 from the ///// response property anyOf list for the response status

    • info

      added discriminator to // response property for the response status

    • info

      added discriminator to /////// response property for the response status

    • info

      added discriminator to ///// response property for the response status

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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