Airflow API Endpoints (vX.Y.Z)

This document outlines the available API endpoints for interacting with Apache Airflow. These endpoints allow you to programmatically manage DAGs, tasks, connections, variables, and monitor the state of your Airflow environment.

Authentication

API requests require authentication. Airflow supports Basic Authentication. You can generate an API token or use your Airflow username and password.

Base URL

The base URL for the Airflow API is typically http://localhost:8080/api/v1, assuming Airflow is running on the default port. Replace localhost:8080 with your Airflow webserver's address and port.

API Endpoints

DAGs

GET /dags

List all DAGs.

GET /dags/{dag_id}

Get details of a specific DAG.

PATCH /dags/{dag_id}

Update a DAG's properties (e.g., enable/disable).

POST /dags/{dag_id}/dagRuns

Trigger a new DAG run.

GET /dags/{dag_id}/dagRuns

List DAG runs for a specific DAG.

GET /dags/{dag_id}/dagRuns/{dag_run_id}

Get details of a specific DAG run.

DELETE /dags/{dag_id}/dagRuns/{dag_run_id}

Delete a DAG run.

Tasks

GET /dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances

List task instances for a specific DAG run.

GET /dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}

Get details of a specific task instance.

GET /dags/{dag_id}/taskInstances/{task_id}/logs

Get the logs for a specific task instance.

POST /dags/{dag_id}/tasks/{task_id}/clear

Clear task state.

POST /dags/{dag_id}/tasks/{task_id}/run

Manually run a task.

Connections

GET /connections

List all connections.

POST /connections

Create a new connection.

GET /connections/{conn_id}

Get details of a specific connection.

PATCH /connections/{conn_id}

Update an existing connection.

DELETE /connections/{conn_id}

Delete a connection.

Variables

GET /variables

List all variables.

POST /variables

Create a new variable.

GET /variables/{key}

Get a specific variable by key.

PATCH /variables/{key}

Update an existing variable.

DELETE /variables/{key}

Delete a variable.

Pools

GET /pools

List all pools.

POST /pools

Create a new pool.

GET /pools/{pool_name}

Get details of a specific pool.

PATCH /pools/{pool_name}

Update an existing pool.

DELETE /pools/{pool_name}

Delete a pool.

Users

GET /users

List all users (requires admin privileges).

POST /users

Create a new user (requires admin privileges).

GET /users/{username}

Get details of a specific user (requires admin privileges).

PATCH /users/{username}

Update an existing user (requires admin privileges).

DELETE /users/{username}

Delete a user (requires admin privileges).

Configuration

GET /config

Get Airflow configuration properties.