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 19 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, authentication docs, and a changelog.

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

Requests are made against 2 base URLs: /api/v1, https://apache.local.

9 operations 6 paths 18 schemas 1 DELETE3 GET2 PATCH3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
3.0
Base URL
http://localhost:8080/api/v1
Authentication
HTTP Basic, OpenID Connect, HTTP Negotiate
License
Resource Areas
1

Authentication & Security 3

Apache Airflow DAGRun API declares 3 security schemes for authenticating requests. It accepts HTTP basic authentication (Basic). It supports OpenID Connect (GoogleOpenId) discovered at https://accounts.google.com/.well-known/openid-configuration. It uses HTTP negotiate authentication (Kerberos).

Paths & Operations 9

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

DAGRun 9
GET
/dags/{dag_id}/dagRuns
Apache Airflow List DAG Runs
get_dag_runs 11 params → 200401
POST
/dags/{dag_id}/dagRuns
Apache Airflow Trigger a New DAG Run
post_dag_run 1 param body → 200400401403404409
DELETE
/dags/{dag_id}/dagRuns/{dag_run_id}
Apache Airflow Delete a DAG Run
delete_dag_run 2 params → 204400401403404
GET
/dags/{dag_id}/dagRuns/{dag_run_id}
Apache Airflow Get a DAG Run
get_dag_run 2 params → 200401403404
PATCH
/dags/{dag_id}/dagRuns/{dag_run_id}
Apache Airflow Modify a DAG Run
update_dag_run_state 2 params body → 200400401403404
POST
/dags/{dag_id}/dagRuns/{dag_run_id}/clear
Apache Airflow Clear a DAG Run
clear_dag_run 2 params body → 200400401403404
PATCH
/dags/{dag_id}/dagRuns/{dag_run_id}/setNote
Apache Airflow Update the DagRun Note.
set_dag_run_note 2 params body → 200400401403404
GET
/dags/{dag_id}/dagRuns/{dag_run_id}/upstreamDatasetEvents
Apache Airflow Get Dataset Events for a DAG Run
get_upstream_dataset_events 2 params → 200401403404
POST
/dags/~/dagRuns/list
Apache Airflow List DAG Runs (batch)
get_dag_runs_batch body → 200400401403

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are TaskInstance (26 properties), DAGRun (14 properties), ListDagRunsForm (11 properties), Job (10 properties). Each schema is shown below with its type and property counts.

DatasetEventCollection
object
A collection of dataset events. New in version 2.4.0
TaskState
string
Task state. Changed in version 2.0.2: 'removed' is added as a possible value. Changed in version 2.2.0: 'deferred' is added as a possible value. Changed in ver…
TaskInstanceCollection
object
Collection of task instances. Changed in version 2.1.0: 'totalentries' field is added.
Trigger
object
5 properties
SLAMiss
objectnull
7 properties
CollectionInfo
object
Metadata about collection.
1 property
DAGRunCollection
object
Collection of DAG runs. Changed in version 2.1.0: 'totalentries' field is added.
DagState
string
DAG State. Changed in version 2.1.3: 'queued' is added as a possible value.
Error
object
[RFC7807](https://tools.ietf.org/html/rfc7807) compliant response.
5 properties 3 required
UpdateDagRunState
object
Modify the state of a DAG run. New in version 2.2.0
1 property
Job
object
10 properties
TaskInstance
object
26 properties
BasicDAGRun
object
8 properties
DatasetEvent
object
A dataset event. New in version 2.4.0
9 properties
DAGRun
object
14 properties
ListDagRunsForm
object
11 properties
ClearDagRun
object
1 property
SetDagRunNote
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

apache-airflow-dagrun-api-openapi.yml Raw ↑

Other APIs Apache Airflow publishes across the network.

Apache Airflow Experimental API (Deprecated)
Apache Airflow Config API
Apache Airflow Connection API
Apache Airflow DAG API
Apache Airflow DagWarning API
Apache Airflow Dataset API
Apache Airflow EventLog API
Apache Airflow ImportError API
Apache Airflow Monitoring API
Apache Airflow Permission API
Apache Airflow Plugin API
Apache Airflow Pool 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.