v1

latestOpenAPI 3.1.02026-07-263992128.7 KB
Pipelines

Get pipeline data

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

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).

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