# Overview To facilitate management, Apache Airflow supports a range of REST API endpoints across its objects. This section provides an overview of the API design, methods, and supported use cases. Most of the endpoints accept `JSON` as input and return `JSON` responses. This means that you must usually add the following headers to your request: ``` Content-type: application/json Accept: application/json ``` ## Resources The term `resource` refers to a single type of object in the Airflow metadata. An API is broken up by its endpoint's corresponding resource. The name of a resource is typically plural and expressed in camelCase. Example: `dagRuns`. Resource names are used as part of endpoint URLs, as well as in API parameters and responses. ## CRUD Operations The platform supports **C**reate, **R**ead, **U**pdate, and **D**elete operations on most resources. You can review the standards for these operations and their standard parameters below. Some endpoints have special behavi
/api/v173 endpoints available
/dagsList DAGs
/dagsUpdate DAGs
/poolsList pools
/poolsCreate a pool
/rolesList roles
/rolesCreate a role
/usersList users
/usersCreate a user
/configGet current configuration
/healthGet instance status
/pluginsGet a list of loaded plugins
/versionGet version information
/datasetsList datasets
/eventLogsList log entries
/providersList providers
/variablesList variables
/variablesCreate a variable
/connectionsList connections
/connectionsCreate a connection
/dagWarningsList dag warnings
/permissionsList permissions
/importErrorsList import errors
/dags/{dag_id}Get basic information about a DAG
/dags/{dag_id}Update a DAG
/dags/{dag_id}Delete a DAG
/datasets/{uri}Get a dataset
/datasets/eventsGet dataset events
/connections/testTest a connection
/users/{username}Get a user
/users/{username}Update a user
/users/{username}Delete a user
/pools/{pool_name}Get a pool
/pools/{pool_name}Update a pool
/pools/{pool_name}Delete a pool
/roles/{role_name}Get a role
/roles/{role_name}Update a role
/roles/{role_name}Delete a role
/dags/{dag_id}/tasksGet tasks for DAG
/dags/~/dagRuns/listList DAG runs (batch)
/dags/{dag_id}/dagRunsList DAG runs
/dags/{dag_id}/dagRunsTrigger a new DAG run
/dags/{dag_id}/detailsGet a simplified representation of DAG
/dagSources/{file_token}Get a source code
/eventLogs/{event_log_id}Get a log entry
/variables/{variable_key}Get a variable
/variables/{variable_key}Update a variable
/variables/{variable_key}Delete a variable
/connections/{connection_id}Get a connection
/connections/{connection_id}Update a connection
/connections/{connection_id}Delete a connection
/dags/{dag_id}/tasks/{task_id}Get simplified representation of a task
/importErrors/{import_error_id}Get an import error
/dags/{dag_id}/clearTaskInstancesClear a set of task instances
/dags/{dag_id}/dagRuns/{dag_run_id}Get a DAG run
/dags/{dag_id}/dagRuns/{dag_run_id}Modify a DAG run
/dags/{dag_id}/dagRuns/{dag_run_id}Delete a DAG run
/dags/~/dagRuns/~/taskInstances/listList task instances (batch)
/dags/{dag_id}/updateTaskInstancesStateSet a state of task instances
/dags/{dag_id}/dagRuns/{dag_run_id}/clearClear a DAG run
/dags/{dag_id}/dagRuns/{dag_run_id}/setNoteUpdate the DagRun note.
/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstancesList task instances
/dags/{dag_id}/dagRuns/{dag_run_id}/upstreamDatasetEventsGet dataset events for a DAG run
/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}Get a task instance
/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}Updates the state of a task instance
/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/linksList extra links
/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/setNoteUpdate the TaskInstance note.
/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/listMappedList mapped task instances
/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/xcomEntriesList XCom entries
/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/{map_index}Get a mapped task instance
/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/{map_index}Updates the state of a mapped task instance
/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/{map_index}/setNoteUpdate the TaskInstance note.
/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/logs/{task_try_number}Get logs
/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/xcomEntries/{xcom_key}Get an XCom entry
# Overview To facilitate management, Apache Airflow supports a range of REST API endpoints across its objects. This section provides an overview of the API design, methods, and supported use cases. Most of the endpoints accept `JSON` as input and return `JSON` responses. This means that you must usually add the following headers to your request: ``` Content-type: application/json Accept: application/json ``` ## Resources The term `resource` refers to a single type of object in the Airflow metadata. An API is broken up by its endpoint's corresponding resource. The name of a resource is typically plural and expressed in camelCase. Example: `dagRuns`. Resource names are used as part of endpoint URLs, as well as in API parameters and responses. ## CRUD Operations The platform supports **C**reate, **R**ead, **U**pdate, and **D**elete operations on most resources. You can review the standards for these operations and their standard parameters below. Some endpoints have special behavi
/api/v173 endpoints available
/dagsList DAGs
/dagsUpdate DAGs
/poolsList pools
/poolsCreate a pool
/rolesList roles
/rolesCreate a role
/usersList users
/usersCreate a user
/configGet current configuration
/healthGet instance status
/pluginsGet a list of loaded plugins
/versionGet version information
/datasetsList datasets
/eventLogsList log entries
/providersList providers
/variablesList variables
/variablesCreate a variable
/connectionsList connections
/connectionsCreate a connection
/dagWarningsList dag warnings
/permissionsList permissions
/importErrorsList import errors
/dags/{dag_id}Get basic information about a DAG
/dags/{dag_id}Update a DAG
/dags/{dag_id}Delete a DAG
/datasets/{uri}Get a dataset
/datasets/eventsGet dataset events
/connections/testTest a connection
/users/{username}Get a user
/users/{username}Update a user
/users/{username}Delete a user
/pools/{pool_name}Get a pool
/pools/{pool_name}Update a pool
/pools/{pool_name}Delete a pool
/roles/{role_name}Get a role
/roles/{role_name}Update a role
/roles/{role_name}Delete a role
/dags/{dag_id}/tasksGet tasks for DAG
/dags/~/dagRuns/listList DAG runs (batch)
/dags/{dag_id}/dagRunsList DAG runs
/dags/{dag_id}/dagRunsTrigger a new DAG run
/dags/{dag_id}/detailsGet a simplified representation of DAG
/dagSources/{file_token}Get a source code
/eventLogs/{event_log_id}Get a log entry
/variables/{variable_key}Get a variable
/variables/{variable_key}Update a variable
/variables/{variable_key}Delete a variable
/connections/{connection_id}Get a connection
/connections/{connection_id}Update a connection
/connections/{connection_id}Delete a connection
/dags/{dag_id}/tasks/{task_id}Get simplified representation of a task
/importErrors/{import_error_id}Get an import error
/dags/{dag_id}/clearTaskInstancesClear a set of task instances
/dags/{dag_id}/dagRuns/{dag_run_id}Get a DAG run
/dags/{dag_id}/dagRuns/{dag_run_id}Modify a DAG run
/dags/{dag_id}/dagRuns/{dag_run_id}Delete a DAG run
/dags/~/dagRuns/~/taskInstances/listList task instances (batch)
/dags/{dag_id}/updateTaskInstancesStateSet a state of task instances
/dags/{dag_id}/dagRuns/{dag_run_id}/clearClear a DAG run
/dags/{dag_id}/dagRuns/{dag_run_id}/setNoteUpdate the DagRun note.
/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstancesList task instances
/dags/{dag_id}/dagRuns/{dag_run_id}/upstreamDatasetEventsGet dataset events for a DAG run
/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}Get a task instance
/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}Updates the state of a task instance
/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/linksList extra links
/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/setNoteUpdate the TaskInstance note.
/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/listMappedList mapped task instances
/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/xcomEntriesList XCom entries
/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/{map_index}Get a mapped task instance
/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/{map_index}Updates the state of a mapped task instance
/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/{map_index}/setNoteUpdate the TaskInstance note.
/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/logs/{task_try_number}Get logs
/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/xcomEntries/{xcom_key}Get an XCom entry