Airflow API (Stable) - Qakka | Specway Docs

Own Qakka? Customize your docs with AI search, analytics, and more.

Claim your docs

Airflow API (Stable)

Qakka

Powered by Specway

Own Qakka? Customize your docs with AI search, analytics, and more.

Claim your docs

Airflow API (Stable)

Qakka

Powered by Specway

Back to APIs Authentication

Endpoints

Get current configurationGET

Create a connectionPOST
Delete a connectionDELETE
Get a connectionGET
List connectionsGET
Test a connectionPOST
Update a connectionPATCH

Clear a DAG runPOST
Clear a set of task instancesPOST
Delete a DAGDELETE
Delete a DAG runDELETE
Get a DAG runGET
Get a mapped task instanceGET
Get a simplified representation of DAGGET
Get a task instanceGET
Get an XCom entryGET
Get basic information about a DAGGET
Get dataset events for a DAG runGET
Get logsGET
Get simplified representation of a taskGET
Get tasks for DAGGET
List DAG runsGET
List DAG runs (batch)POST
List DAGsGET
List extra linksGET
List mapped task instancesGET
List task instancesGET
List task instances (batch)POST
List XCom entriesGET
Modify a DAG runPATCH
Set a state of task instancesPOST
Trigger a new DAG runPOST
Update a DAGPATCH
Update DAGsPATCH
Update the DagRun note.PATCH
Update the TaskInstance note.PATCH
Update the TaskInstance note.PATCH
Updates the state of a mapped task instancePATCH
Updates the state of a task instancePATCH

Get a source codeGET

List dag warningsGET

Get a datasetGET
Get dataset eventsGET
List datasetsGET

Get a log entryGET
List log entriesGET

Get instance statusGET

Get an import errorGET
List import errorsGET

List permissionsGET

Get a list of loaded pluginsGET

Create a poolPOST
Delete a poolDELETE
Get a poolGET
List poolsGET
Update a poolPATCH

List providersGET

Create a rolePOST
Delete a roleDELETE
Get a roleGET
List rolesGET
Update a rolePATCH

Create a userPOST
Delete a userDELETE
Get a userGET
List usersGET
Update a userPATCH

Create a variablePOST
Delete a variableDELETE
Get a variableGET
List variablesGET
Update a variablePATCH

Get version informationGET

Back to APIs Authentication

Endpoints

Get current configurationGET

Create a connectionPOST
Delete a connectionDELETE
Get a connectionGET
List connectionsGET
Test a connectionPOST
Update a connectionPATCH

Clear a DAG runPOST
Clear a set of task instancesPOST
Delete a DAGDELETE
Delete a DAG runDELETE
Get a DAG runGET
Get a mapped task instanceGET
Get a simplified representation of DAGGET
Get a task instanceGET
Get an XCom entryGET
Get basic information about a DAGGET
Get dataset events for a DAG runGET
Get logsGET
Get simplified representation of a taskGET
Get tasks for DAGGET
List DAG runsGET
List DAG runs (batch)POST
List DAGsGET
List extra linksGET
List mapped task instancesGET
List task instancesGET
List task instances (batch)POST
List XCom entriesGET
Modify a DAG runPATCH
Set a state of task instancesPOST
Trigger a new DAG runPOST
Update a DAGPATCH
Update DAGsPATCH
Update the DagRun note.PATCH
Update the TaskInstance note.PATCH
Update the TaskInstance note.PATCH
Updates the state of a mapped task instancePATCH
Updates the state of a task instancePATCH

Get a source codeGET

List dag warningsGET

Get a datasetGET
Get dataset eventsGET
List datasetsGET

Get a log entryGET
List log entriesGET

Get instance statusGET

Get an import errorGET
List import errorsGET

List permissionsGET

Get a list of loaded pluginsGET

Create a poolPOST
Delete a poolDELETE
Get a poolGET
List poolsGET
Update a poolPATCH

List providersGET

Create a rolePOST
Delete a roleDELETE
Get a roleGET
List rolesGET
Update a rolePATCH

Create a userPOST
Delete a userDELETE
Get a userGET
List usersGET
Update a userPATCH

Create a variablePOST
Delete a variableDELETE
Get a variableGET
List variablesGET
Update a variablePATCH

Get version informationGET

Airflow API (Stable)

# 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

Base URL

/api/v1

Endpoints

73 endpoints available

List DAGs

Update DAGs

List pools

Create a pool

List roles

Create a role

List users

Create a user

Get current configuration

Get instance status

Get a list of loaded plugins

Get version information

List datasets

List log entries

List providers

List variables

Create a variable

List connections

Create a connection

List dag warnings

List permissions

/importErrors

List 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/events

Get dataset events

/connections/test

Test 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}/tasks

Get tasks for DAG

/dags/~/dagRuns/list

List DAG runs (batch)

/dags/{dag_id}/dagRuns

List DAG runs

/dags/{dag_id}/dagRuns

Trigger a new DAG run

/dags/{dag_id}/details

Get 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}/clearTaskInstances

Clear 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/list

List task instances (batch)

/dags/{dag_id}/updateTaskInstancesState

Set a state of task instances

/dags/{dag_id}/dagRuns/{dag_run_id}/clear

Clear a DAG run

/dags/{dag_id}/dagRuns/{dag_run_id}/setNote

Update the DagRun note.

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

List task instances

/dags/{dag_id}/dagRuns/{dag_run_id}/upstreamDatasetEvents

Get 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}/links

List extra links

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

Update the TaskInstance note.

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

List mapped task instances

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

List 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}/setNote

Update 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

Airflow API (Stable)

# 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

Base URL

/api/v1

Endpoints

73 endpoints available

List DAGs

Update DAGs

List pools

Create a pool

List roles

Create a role

List users

Create a user

Get current configuration

Get instance status

Get a list of loaded plugins

Get version information

List datasets

List log entries

List providers

List variables

Create a variable

List connections

Create a connection

List dag warnings

List permissions

/importErrors

List 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/events

Get dataset events

/connections/test

Test 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}/tasks

Get tasks for DAG

/dags/~/dagRuns/list

List DAG runs (batch)

/dags/{dag_id}/dagRuns

List DAG runs

/dags/{dag_id}/dagRuns

Trigger a new DAG run

/dags/{dag_id}/details

Get 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}/clearTaskInstances

Clear 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/list

List task instances (batch)

/dags/{dag_id}/updateTaskInstancesState

Set a state of task instances

/dags/{dag_id}/dagRuns/{dag_run_id}/clear

Clear a DAG run

/dags/{dag_id}/dagRuns/{dag_run_id}/setNote

Update the DagRun note.

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

List task instances

/dags/{dag_id}/dagRuns/{dag_run_id}/upstreamDatasetEvents

Get 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}/links

List extra links

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

Update the TaskInstance note.

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

List mapped task instances

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

List 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}/setNote

Update 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