GEgetorchestra
Pipelines

Start a pipeline run

Changed on

Start a pipeline run. The pipeline can be identified by alias or pipeline ID.

All request body fields are optional. Use branch and commit for Git-backed pipelines, versionNumber for Orchestra-backed published versions, and runInputs for values required by pipeline inputs. The response includes a pipelineRunId you can use to poll run status.

Any other JSON body, such as a webhook sent by another tool, still starts the run, with default options; requestBodyMessage and requestBodyErrors in the response say which happened. Either way the whole body is available to the pipeline's webhook.runInputs as ${{ outputs.payload }}, for example ${{ outputs.payload.connection_id }}, or ${{ outputs.payload['connectionId'] }} for a key with capitals, so task conditions can act on it through ${{ inputs.<name> }}. Bodies over 64 KiB are not kept.

post/pipelines/{pipeline_id_or_alias}/start

Request

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

string uuid4 required
OR
string required

Pipeline ID or alias.

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

versionNumberinteger nullable
branchstring nullable
commitstring nullable
taskIdsstring[] nullable
continueDownstreamRunboolean nullable
runInputsobject nullable
ciRunIdstring nullable
environmentstring nullable
environmentOverridesobject nullable
retryFromFailedboolean

Response

Successful response.

idstring uuid4 required
pipelineRunIdstring uuid4 required
messagestring nullable

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

    • info

      added AIRFLOW discriminator mapping keys to the // request property

    • info

      added the new dict enum value to the request property ////

    • info

      added the new list enum value to the request property ////

    • info

      request property //// list-of-types was widened by adding types array and object to media type application/json