Orchestration API
Orchestration endpoints expose provider-backed pipeline visibility under
/api/v1.0/spaces/{slug}/orchestration. They are space scoped and require the
current user to have access to the target space.
Pipelines
| Method | Endpoint | Description |
|---|---|---|
GET | /spaces/{slug}/orchestration/pipelines | List pipelines. |
GET | /spaces/{slug}/orchestration/pipelines/{pipeline_id} | Fetch one pipeline. |
PATCH | /spaces/{slug}/orchestration/pipelines/{pipeline_id}/team | Assign or clear the owning team. |
PATCH | /spaces/{slug}/orchestration/pipelines/{pipeline_id}/criticality | Update criticality. |
POST | /spaces/{slug}/orchestration/pipelines/{pipeline_id}/trigger | Trigger a provider-backed pipeline run. |
List Filters
| Parameter | Description |
|---|---|
provider | Provider name: airflow, luigi, dagster, or prefect. |
status | Current pipeline status. |
owner | Provider owner string. |
criticality | Criticality filter. |
team_id | Owning Qarion team. |
connector_id | Source connector that synced the pipeline. |
q | Text search. |
watched_only | Return only pipelines watched by the current user. |
days | Run window used for summary metrics. |
Pipeline list endpoints use the large pagination defaults and return pagination headers.
Trigger Pipeline
curl -X POST "https://api.qarion.com/api/v1.0/spaces/finance/orchestration/pipelines/{pipeline_id}/trigger" \
-H "Authorization: Bearer YOUR_API_KEY"
Manual trigger is supported for Airflow, Dagster, and Prefect pipelines. Dagster
also accepts optional run_config_data in the request body. Provider errors
return the provider-specific status code and message.
Runs
| Method | Endpoint | Description |
|---|---|---|
GET | /spaces/{slug}/orchestration/pipelines/{pipeline_id}/runs | List runs for a pipeline. |
GET | /spaces/{slug}/orchestration/runs/{run_id} | Fetch one run with task details. |
Run list filters include started_from, started_to, status, and run_type.
Responses include pagination headers.
Run and Task Comments
| Method | Endpoint | Description |
|---|---|---|
GET | /spaces/{slug}/orchestration/runs/{run_id}/comments | List run comments. |
POST | /spaces/{slug}/orchestration/runs/{run_id}/comments | Create a run comment. |
GET | /spaces/{slug}/orchestration/task-runs/{task_run_id}/comments | List task-run comments. |
POST | /spaces/{slug}/orchestration/task-runs/{task_run_id}/comments | Create a task-run comment. |
PUT | /spaces/{slug}/orchestration/comments/{comment_id} | Update an orchestration comment. |
PATCH | /spaces/{slug}/orchestration/comments/{comment_id} | Update an orchestration comment. |
DELETE | /spaces/{slug}/orchestration/comments/{comment_id} | Delete an orchestration comment. |
Comments are validated against the run or task run in the current space before they are returned or modified.
Connector Sync
| Method | Endpoint | Description |
|---|---|---|
POST | /spaces/{slug}/orchestration/connectors/{connector_id}/sync | Sync an orchestration connector. |
Airflow, Luigi, Dagster, and Prefect connectors can be synced through this generic endpoint. The connector must belong to the target space and the current user must be authorized to edit the connector.
Prefect connectors target the Prefect v3 REST API. Configure base_url with the
API root, such as http://localhost:4200/api or a Prefect Cloud workspace API
URL. Self-hosted Prefect can use auth_mode: "none"; Prefect Cloud and API-key
setups use auth_mode: "bearer" with bearer_token or api_token. Sync imports
deployments as pipelines, flow runs as pipeline runs, and task runs as task runs.
Qarion only builds external links when public_base_url is configured.
Related
- Connectors API — Manage source connectors
- Comments API — Shared comment request and response shape
- Airflow Integration Tutorial — DAG integration patterns