Airflow integration¶
This page lists the Airflow integration's tools and how to configure it.
Tools¶
| Tool Name | Description | Parameters |
|---|---|---|
airflow_get_task_log |
Get logs for a specific Airflow task instance. | - dag_id (string): The ID of the DAG- dag_run_id (string): The ID of the DAG Run- task_id (string): The ID of the task- try_number (number): The try number of the task instance |
airflow_list_dags |
List all DAGs in Airflow. | - limit (number, optional): Number of results per page- offset (number, optional): Page offset |
airflow_get_dag |
Retrieve a specific DAG by ID. | - dag_id (string): The ID of the DAG |
airflow_update_dag |
Update a DAG (e.g., pause/unpause) | - dag_id (string): The ID of the DAG- is_paused (boolean): Set to true to pause the DAG |
airflow_list_dag_runs |
List DAG runs for a specified DAG ID. | - dag_ids (array, optional): Dag Ids- order_by (string, optional): Order By- page_offset (number, optional): Page Offset (optional, default 0)- page_limit (number, optional): Page Limit (optional, default 100)- states (array, optional): States- run_after_gte (string, optional): Run After Gte- run_after_lte (string, optional): Run After Lte- logical_date_gte (string, optional): Logical Date Gte- logical_date_lte (string, optional): Logical Date Lte- start_date_gte (string, optional): Start Date Gte- start_date_lte (string, optional): Start Date Lte- end_date_gte (string, optional): End Date Gte- end_date_lte (string, optional): End Date Lte |
airflow_create_dag_run |
Create a new DAG run for a specified DAG ID. | - dag_id (string): ID of the DAG- dag_run_id (string, optional): Dag Run Id- data_interval_start (string, optional): Data Interval Start- data_interval_end (string, optional): Data Interval End- logical_date (string, optional): Logical Date- run_after (string, optional): Run After- conf (record, optional): Configuration parameters for the DAG run- note (string, optional): Note |
airflow_update_dag_run |
Update an existing DAG run. | - dag_id (string): ID of the DAG- dag_run_id (string): ID of the DAG run- state (string, optional): New state for the DAG run- note (string, optional): Notes to add to the DAG run |
airflow_get_upstream_asset_events |
Get upstream asset events for a specific run id. | - dag_id (string): The ID of the DAG- dag_run_id (string): The ID of the DAG Run |
airflow_list_dag_tasks |
List all tasks in a specific DAG. | - dag_id (string): ID of the DAG |
airflow_get_dag_task |
Retrieve a specific task in a DAG. | - dag_id (string): ID of the DAG- task_id (string): ID of the task |
airflow_list_task_instances |
List task instances using the batch endpoint. | - dag_ids (array, optional): Dag Ids- dag_run_ids (array, optional): Dag Run Ids- task_ids (array, optional): Task Ids- state (array, optional): State- run_after_gte (string, optional): Run After Gte- run_after_lte (string, optional): Run After Lte- logical_date_gte (string, optional): Logical Date Gte- logical_date_lte (string, optional): Logical Date Lte- start_date_gte (string, optional): Start Date Gte- start_date_lte (string, optional): Start Date Lte- end_date_gte (string, optional): End Date Gte- end_date_lte (string, optional): End Date Lte- duration_gte (number, optional): Duration Gte- duration_lte (number, optional): Duration Lte- pool (array, optional): Pool- queue (array, optional): Queue- executor (array, optional): Executor- page_offset (number, optional): Page Offset (optional, default 0)- page_limit (number, optional): Page Limit (optional, default 100)- order_by (string, optional): Order By |
airflow_get_task_instance |
Retrieve a specific task instance in a DAG run. | - dag_id (string): ID of the DAG- dag_run_id (string): ID of the DAG run- task_id (string): ID of the task |
airflow_update_task_instance |
Update state and notes of a specific task instance. | - dag_id (string): ID of the DAG- dag_run_id (string): ID of the DAG run- task_id (string): ID of the task- map_index (number, optional): Map index of the task instance (default -1)- new_state (string, optional): New state for the task instance- note (string, optional): Notes to add to the task instance- include_upstream (boolean, optional): Include Upstream (default false)- include_downstream (boolean, optional): Include Downstream (default false)- include_future (boolean, optional): Include Future (default false)- include_past (boolean, optional): Include Past (default false) |
airflow_create_asset_event |
Create a dataset asset event to trigger downstream DAGs. | - asset_id (number): Asset Id that was updated- extra (record, optional): Additional metadata about the event |
Configuration¶
The Airflow integration uses the Airflow 3 REST API (/api/v2).
| Setting | What to enter |
|---|---|
| Airflow API URL | Your Airflow server's address, such as https://airflow.example.com, without /api/v2 |
| Airflow Username and Airflow Password | The Airflow user the agent signs in as. Give it only the permissions the tools need. |
| Authentication mechanism | Token Authentication or Basic Authentication |
- Token Authentication signs in at your server's
/auth/tokenendpoint with the username and password, and uses the token Airflow returns. Airflow 3 provides this endpoint, so there's no separate API token to create. - Basic Authentication sends the username and password with every request. Use it only if your Airflow accepts basic authentication for its API.
For more details about Airflow authentication, refer to the official Airflow documentation.
