The DagRun API from Apache Airflow — 6 operation(s) for dagrun.
openapi: 3.1.0
info:
title: Airflow Asset DagRun API
description: Airflow API. All endpoints located under ``/api/v2`` can be used safely, are stable and backward compatible. Endpoints located under ``/ui`` are dedicated to the UI and are subject to breaking change depending on the need of the frontend. Users should not rely on those but use the public ones instead.
version: '2'
tags:
- name: DagRun
paths:
/api/v2/dags/{dag_id}/dagRuns/{dag_run_id}:
get:
tags:
- DagRun
summary: Airflow Get Dag Run
operationId: get_dag_run
security:
- OAuth2PasswordBearer: []
- HTTPBearer: []
parameters:
- name: dag_id
in: path
required: true
schema:
type: string
title: Dag Id
- name: dag_run_id
in: path
required: true
schema:
type: string
title: Dag Run Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/DAGRunResponse'
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Unauthorized
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Forbidden
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Not Found
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
delete:
tags:
- DagRun
summary: Airflow Delete Dag Run
description: Delete a DAG Run entry.
operationId: delete_dag_run
security:
- OAuth2PasswordBearer: []
- HTTPBearer: []
parameters:
- name: dag_id
in: path
required: true
schema:
type: string
title: Dag Id
- name: dag_run_id
in: path
required: true
schema:
type: string
title: Dag Run Id
responses:
'204':
description: Successful Response
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Unauthorized
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Forbidden
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Bad Request
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Not Found
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
patch:
tags:
- DagRun
summary: Airflow Patch Dag Run
description: Modify a DAG Run.
operationId: patch_dag_run
security:
- OAuth2PasswordBearer: []
- HTTPBearer: []
parameters:
- name: dag_id
in: path
required: true
schema:
type: string
title: Dag Id
- name: dag_run_id
in: path
required: true
schema:
type: string
title: Dag Run Id
- name: update_mask
in: query
required: false
schema:
anyOf:
- type: array
items:
type: string
- type: 'null'
title: Update Mask
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DAGRunPatchBody'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/DAGRunResponse'
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Unauthorized
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Forbidden
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Bad Request
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Not Found
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/upstreamAssetEvents:
get:
tags:
- DagRun
summary: Airflow Get Upstream Asset Events
description: If dag run is asset-triggered, return the asset events that triggered it.
operationId: get_upstream_asset_events
security:
- OAuth2PasswordBearer: []
- HTTPBearer: []
parameters:
- name: dag_id
in: path
required: true
schema:
type: string
title: Dag Id
- name: dag_run_id
in: path
required: true
schema:
type: string
title: Dag Run Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/AssetEventCollectionResponse'
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Unauthorized
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Forbidden
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Not Found
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/clear:
post:
tags:
- DagRun
summary: Airflow Clear Dag Run
operationId: clear_dag_run
security:
- OAuth2PasswordBearer: []
- HTTPBearer: []
parameters:
- name: dag_id
in: path
required: true
schema:
type: string
title: Dag Id
- name: dag_run_id
in: path
required: true
schema:
type: string
title: Dag Run Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DAGRunClearBody'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/TaskInstanceCollectionResponse'
- $ref: '#/components/schemas/DAGRunResponse'
title: Response Clear Dag Run
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Unauthorized
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Forbidden
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Not Found
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v2/dags/{dag_id}/dagRuns:
get:
tags:
- DagRun
summary: Airflow Get Dag Runs
description: 'Get all DAG Runs.
This endpoint allows specifying `~` as the dag_id to retrieve Dag Runs for all DAGs.'
operationId: get_dag_runs
security:
- OAuth2PasswordBearer: []
- HTTPBearer: []
parameters:
- name: dag_id
in: path
required: true
schema:
type: string
title: Dag Id
- name: limit
in: query
required: false
schema:
type: integer
minimum: 0
default: 50
title: Limit
- name: offset
in: query
required: false
schema:
type: integer
minimum: 0
default: 0
title: Offset
- name: run_after_gte
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Run After Gte
- name: run_after_gt
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Run After Gt
- name: run_after_lte
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Run After Lte
- name: run_after_lt
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Run After Lt
- name: logical_date_gte
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Logical Date Gte
- name: logical_date_gt
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Logical Date Gt
- name: logical_date_lte
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Logical Date Lte
- name: logical_date_lt
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Logical Date Lt
- name: start_date_gte
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Start Date Gte
- name: start_date_gt
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Start Date Gt
- name: start_date_lte
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Start Date Lte
- name: start_date_lt
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Start Date Lt
- name: end_date_gte
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: 'null'
title: End Date Gte
- name: end_date_gt
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: 'null'
title: End Date Gt
- name: end_date_lte
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: 'null'
title: End Date Lte
- name: end_date_lt
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: 'null'
title: End Date Lt
- name: duration_gte
in: query
required: false
schema:
anyOf:
- type: number
- type: 'null'
title: Duration Gte
- name: duration_gt
in: query
required: false
schema:
anyOf:
- type: number
- type: 'null'
title: Duration Gt
- name: duration_lte
in: query
required: false
schema:
anyOf:
- type: number
- type: 'null'
title: Duration Lte
- name: duration_lt
in: query
required: false
schema:
anyOf:
- type: number
- type: 'null'
title: Duration Lt
- name: updated_at_gte
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Updated At Gte
- name: updated_at_gt
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Updated At Gt
- name: updated_at_lte
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Updated At Lte
- name: updated_at_lt
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Updated At Lt
- name: conf_contains
in: query
required: false
schema:
type: string
title: Conf Contains
- name: run_type
in: query
required: false
schema:
type: array
items:
type: string
title: Run Type
- name: state
in: query
required: false
schema:
type: array
items:
type: string
title: State
- name: dag_version
in: query
required: false
schema:
type: array
items:
type: integer
title: Dag Version
- name: bundle_version
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Bundle Version
- name: order_by
in: query
required: false
schema:
type: array
items:
type: string
description: 'Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `id, state, dag_id, run_id, logical_date, run_after, start_date, end_date, updated_at, conf, duration, dag_run_id`'
default:
- id
title: Order By
description: 'Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `id, state, dag_id, run_id, logical_date, run_after, start_date, end_date, updated_at, conf, duration, dag_run_id`'
- name: run_id_pattern
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). or the pipe `|` operator for OR logic (e.g. `dag1 | dag2`). Regular expressions are **not** supported.
title: Run Id Pattern
description: SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). or the pipe `|` operator for OR logic (e.g. `dag1 | dag2`). Regular expressions are **not** supported.
- name: triggering_user_name_pattern
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). or the pipe `|` operator for OR logic (e.g. `dag1 | dag2`). Regular expressions are **not** supported.
title: Triggering User Name Pattern
description: SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). or the pipe `|` operator for OR logic (e.g. `dag1 | dag2`). Regular expressions are **not** supported.
- name: dag_id_pattern
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). or the pipe `|` operator for OR logic (e.g. `dag1 | dag2`). Regular expressions are **not** supported.
title: Dag Id Pattern
description: SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). or the pipe `|` operator for OR logic (e.g. `dag1 | dag2`). Regular expressions are **not** supported.
- name: partition_key_pattern
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). or the pipe `|` operator for OR logic (e.g. `dag1 | dag2`). Regular expressions are **not** supported.
title: Partition Key Pattern
description: SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). or the pipe `|` operator for OR logic (e.g. `dag1 | dag2`). Regular expressions are **not** supported.
- name: consuming_asset_pattern
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: Filter by consuming asset name or URI using pattern matching
title: Consuming Asset Pattern
description: Filter by consuming asset name or URI using pattern matching
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/DAGRunCollectionResponse'
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Unauthorized
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Forbidden
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Not Found
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
post:
tags:
- DagRun
summary: Airflow Trigger Dag Run
description: Trigger a DAG.
operationId: trigger_dag_run
security:
- OAuth2PasswordBearer: []
- HTTPBearer: []
parameters:
- name: dag_id
in: path
required: true
schema:
title: Dag Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TriggerDAGRunPostBody'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/DAGRunResponse'
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Unauthorized
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Forbidden
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Bad Request
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Not Found
'409':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Conflict
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/wait:
get:
tags:
- DagRun
summary: 'Airflow Experimental: Wait for a Dag Run to Complete, and Return Task Results if Requested.'
description: 🚧 This is an experimental endpoint and may change or be removed without notice.Successful response are streamed as newline-delimited JSON (NDJSON). Each line is a JSON object representing the DAG run state.
operationId: wait_dag_run_until_finished
security:
- OAuth2PasswordBearer: []
- HTTPBearer: []
parameters:
- name: dag_id
in: path
required: true
schema:
type: string
title: Dag Id
- name: dag_run_id
in: path
required: true
schema:
type: string
title: Dag Run Id
- name: interval
in: query
required: true
schema:
type: number
exclusiveMinimum: 0.0
description: Seconds to wait between dag run state checks
title: Interval
description: Seconds to wait between dag run state checks
- name: result
in: query
required: false
schema:
anyOf:
- type: array
items:
type: string
- type: 'null'
description: Collect result XCom from task. Can be set multiple times.
title: Result
description: Collect result XCom from task. Can be set multiple times.
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
application/x-ndjson:
schema:
type: string
example: '{"state": "running"}
{"state": "success", "results": {"op": 42}}
'
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Unauthorized
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Forbidden
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Not Found
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v2/dags/{dag_id}/dagRuns/list:
post:
tags:
- DagRun
summary: Airflow Get List Dag Runs Batch
description: Get a list of DAG Runs.
operationId: get_list_dag_runs_batch
security:
- OAuth2PasswordBearer: []
- HTTPBearer: []
parameters:
- name: dag_id
in: path
required: true
schema:
const: '~'
type: string
title: Dag Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DAGRunsBatchBody'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/DAGRunCollectionResponse'
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Unauthorized
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Forbidden
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Not Found
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
components:
schemas:
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
input:
title: Input
ctx:
type: object
title: Context
type: object
required:
- loc
- msg
- type
title: ValidationError
DAGRunClearBody:
properties:
dry_run:
type: boolean
title: Dry Run
default: true
only_failed:
type: boolean
title: Only Failed
default: false
run_on_latest_version:
type: boolean
title: Run On Latest Version
description: (Experimental) Run on the latest bundle version of the Dag after clearing the Dag Run.
default: false
additionalProperties: false
type: object
title: DAGRunClearBody
description: DAG Run serializer for clear endpoint body.
DAGRunCollectionResponse:
properties:
dag_runs:
items:
$ref: '#/components/schemas/DAGRunResponse'
type: array
title: Dag Runs
total_entries:
type: integer
title: Total Entries
type: object
required:
- dag_runs
- total_entries
title: DAGRunCollectionResponse
description: DAG Run Collection serializer for responses.
DAGRunsBatchBody:
properties:
order_by:
anyOf:
- type: string
- type: 'null'
title: Order By
page_offset:
type: integer
minimum: 0.0
title: Page Offset
default: 0
page_limit:
type: integer
minimum: 0.0
title: Page Limit
default: 100
dag_ids:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Dag Ids
states:
anyOf:
- items:
anyOf:
- $ref: '#/components/schemas/DagRunState'
- type: 'null'
type: array
- type: 'null'
title: States
run_after_gte:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Run After Gte
run_after_gt:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Run After Gt
run_after_lte:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Run After Lte
run_after_lt:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Run After Lt
logical_date_gte:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Logical Date Gte
logical_date_gt:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Logical Date Gt
logical_date_lte:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Logical Date Lte
logical_date_lt:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Logical Date Lt
start_date_gte:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Start Date Gte
start_date_gt:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Start Date Gt
start_date_lte:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Start Date Lte
start_date_lt:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Start Date Lt
end_date_gte:
anyOf:
- type: string
format: date-time
- type: 'null'
title: End Date Gte
end_date_gt:
anyOf:
- type: string
format: date-time
- type: 'null'
title: End Date Gt
end_date_lte:
anyOf:
- type: string
format: date-time
- type: 'null'
title: End Date Lte
end_date_lt:
anyOf:
- type: string
format: date-time
- type: 'null'
title: End Date Lt
duration_gte:
anyOf:
- type: number
- type: 'null'
title: Duration Gte
duration_gt:
anyOf:
- type: number
- type: 'null'
title: Duration Gt
duration_lte:
anyOf:
- type: number
- type: 'null'
title: Duration Lte
duration_lt:
anyOf:
- type: number
- type: 'null'
title: Duration Lt
conf_contains:
anyOf:
- type: string
- type: 'null'
title: Conf Contains
additionalProperties: false
type: object
title: DAGRunsBatchBody
description: List DAG Runs body for batch endpoint.
DagRunType:
type: string
enum:
- backfill
- scheduled
- manual
- operator_triggered
- asset_triggered
- asset_materialization
title: DagRunType
description: Class with DagRun types.
DAGRunResponse:
properties:
dag_run_id:
type: string
title: Dag Run Id
dag_id:
type: string
title: Dag Id
logical_date:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Logical Date
queued_at:
anyOf:
- type: string
format: date-time
- type: 'null'
# --- truncated at 32 KB (51 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/airflow/refs/heads/main/openapi/airflow-dagrun-api-openapi.yml