How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Apache Airflow DagRun API

The DagRun API from Apache Airflow — 6 operation(s) for dagrun.

Apache Airflow DagRun API is one of 26 APIs that Apache Airflow publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include DAGRun. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 9 operations across 6 paths, and defines 23 schemas. It is described by OpenAPI 3.2.0, at version 2.

Requests are made against a single base URL, http://localhost:8080/api/v2.

9 operations 6 paths 23 schemas 1 DELETE4 GET1 PATCH3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2
Base URL
http://localhost:8080/api/v2
Authentication
OAuth 2.0, HTTP Bearer
Resource Areas
1

Authentication & Security 2

Apache Airflow DagRun API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (OAuth2PasswordBearer) using the password flow. It accepts HTTP bearer tokens (HTTPBearer).

  • OAuth2PasswordBearer — To authenticate Airflow API requests, clients must include a JWT (JSON Web Token) in the Authorization header of each request. This token is used to verify the…

Paths & Operations 9

Across 6 paths, the API surfaces 9 operations — 1 DELETE, 4 GET, 1 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.

DagRun 9
GET
/api/v2/dags/{dag_id}/dagRuns/{dag_run_id}
Airflow Get Dag Run
get_dag_run 2 params → 200401403404422
DELETE
/api/v2/dags/{dag_id}/dagRuns/{dag_run_id}
Airflow Delete Dag Run
delete_dag_run 2 params → 204401403400404422
PATCH
/api/v2/dags/{dag_id}/dagRuns/{dag_run_id}
Airflow Patch Dag Run
patch_dag_run 3 params body → 200401403400404422
GET
/api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/upstreamAssetEvents
Airflow Get Upstream Asset Events
get_upstream_asset_events 2 params → 200401403404422
POST
/api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/clear
Airflow Clear Dag Run
clear_dag_run 2 params body → 200401403404422
GET
/api/v2/dags/{dag_id}/dagRuns
Airflow Get Dag Runs
get_dag_runs 38 params → 200401403404422
POST
/api/v2/dags/{dag_id}/dagRuns
Airflow Trigger Dag Run
trigger_dag_run 1 param body → 200401403400404409422
GET
/api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/wait
Airflow Experimental: Wait for a Dag Run to Complete, and Return Task Results if Requested.
wait_dag_run_until_finished 4 params → 200401403404422
POST
/api/v2/dags/{dag_id}/dagRuns/list
Airflow Get List Dag Runs Batch
get_list_dag_runs_batch 1 param body → 200401403404422

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are TaskInstanceResponse (34 properties), DAGRunsBatchBody (26 properties), DAGRunResponse (21 properties), AssetEventResponse (13 properties). Each schema is shown below with its type and property counts.

DAGRunPatchBody
object
DAG Run Serializer for PATCH requests.
2 properties
TaskInstanceCollectionResponse
object
Task instance collection response supporting both offset and cursor pagination. A single flat model is used instead of a discriminated union (Annotated[Offset…
4 properties 1 required
HTTPValidationError
object
1 property
DagRunType
string
Class with DagRun types.
DagVersionResponse
object
Dag Version serializer for responses.
8 properties 8 required
TriggerDAGRunPostBody
object
Trigger DAG Run Serializer for POST body.
8 properties 1 required
HTTPExceptionResponse
object
HTTPException Model used for error response.
1 property 1 required
DAGRunClearBody
object
DAG Run serializer for clear endpoint body.
3 properties
JsonValue
DAGRunCollectionResponse
object
DAG Run Collection serializer for responses.
2 properties 2 required
DagRunTriggeredByType
string
Class with TriggeredBy types for DagRun.
JobResponse
object
Job serializer for responses.
11 properties 10 required
TriggerResponse
object
Trigger serializer for responses.
6 properties 6 required
TaskInstanceState
string
All possible states that a Task Instance can be in. Note that None is also allowed, so always use this in a type hint with Optional.
DagRunState
string
All possible states that a DagRun can be in. These are "shared" with TaskInstanceState in some parts of the code, so please ensure that their values always mat…
ValidationError
object
5 properties 3 required
TaskInstanceResponse
object
TaskInstance serializer for responses.
34 properties 33 required
DAGRunsBatchBody
object
List DAG Runs body for batch endpoint.
26 properties
DagRunAssetReference
object
DagRun serializer for asset responses.
9 properties 9 required
AssetEventResponse
object
Asset event serializer for responses.
13 properties 5 required
DAGRunResponse
object
DAG Run serializer for responses.
21 properties 21 required
DAGRunPatchStates
string
Enum for DAG Run states when updating a DAG Run.
AssetEventCollectionResponse
object
Asset event collection response.
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

airflow-dagrun-api-openapi.yml Raw ↑

Other APIs Apache Airflow publishes across the network.

Apache Airflow Asset API
Apache Airflow Backfill API
Apache Airflow Config API
Apache Airflow Connection API
Apache Airflow DAG API
Apache Airflow DAG Parsing API
Apache Airflow DagSource API
Apache Airflow DagStats API
Apache Airflow DagVersion API
Apache Airflow DagWarning API
Apache Airflow Event Log API
Apache Airflow experimental API
Where this information came from

This is an independent, third-party profile of Apache Airflow DagRun API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.