v1

latestOpenAPI 3.1.02026-07-263992128.7 KB

Pipelines

Start a pipeline run

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.

post/pipelines/{pipeline_id_or_alias}/start

Path parameters

string uuid4 required

string required

Pipeline ID or alias.

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