# 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 u
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: https://apache.local
auth: b a s i c ,
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
# 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: applica
| method | path | what the vendor says it does |
|---|---|---|
GET | /config | Get current configuration Config |
GET | /connections | List connections Connection |
POST | /connections | Create a connection Connection |
POST | /connections/test | Test a connection Test a connection. *New in version 2.2.0* Connection |
GET | /connections/{connection_id} | Get a connection Connection |
PATCH | /connections/{connection_id} | Update a connection Connection |
DELETE | /connections/{connection_id} | Delete a connection Connection |
GET | /dagSources/{file_token} | Get a source code Get a source code using file token. DAG |
GET | /dagWarnings | List dag warnings DagWarning |
GET | /dags | List DAGs List DAGs in the database. `dag_id_pattern` can be set to match dags of a specific pattern DAG |
PATCH | /dags | Update DAGs Update DAGs of a given dag_id_pattern using UpdateMask. This endpoint allows specifying `~` as the |
GET | /dags/{dag_id} | Get basic information about a DAG Presents only information available in database (DAGModel). If you need deta |
PATCH | /dags/{dag_id} | Update a DAG DAG |
DELETE | /dags/{dag_id} | Delete a DAG Deletes all metadata related to the DAG, including finished DAG Runs and Tasks. Logs are not dele |
POST | /dags/{dag_id}/clearTaskInstances | Clear a set of task instances Clears a set of task instances associated with the DAG for a specified date rang |
GET | /dags/{dag_id}/dagRuns | List DAG runs This endpoint allows specifying `~` as the dag_id to retrieve DAG runs for all DAGs. DAGRun |
POST | /dags/{dag_id}/dagRuns | Trigger a new DAG run DAGRun |
GET | /dags/{dag_id}/dagRuns/{dag_run_id} | Get a DAG run DAGRun |
PATCH | /dags/{dag_id}/dagRuns/{dag_run_id} | Modify a DAG run Modify a DAG run. *New in version 2.2.0* DAGRun |
DELETE | /dags/{dag_id}/dagRuns/{dag_run_id} | Delete a DAG run DAGRun |
POST | /dags/{dag_id}/dagRuns/{dag_run_id}/clear | Clear a DAG run Clear a DAG run. *New in version 2.4.0* DAGRun |
PATCH | /dags/{dag_id}/dagRuns/{dag_run_id}/setNote | Update the DagRun note. Update the manual user note of a DagRun. *New in version 2.5.0* DAGRun |
GET | /dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances | List task instances This endpoint allows specifying `~` as the dag_id, dag_run_id to retrieve DAG runs for all |
GET | /dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id} | Get a task instance TaskInstance |
PATCH | /dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id} | Updates the state of a task instance Updates the state for single task instance. *New in version 2.5.0* TaskIn |
GET | /dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/links | List extra links List extra links for task instance. TaskInstance |
GET | /dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/listMapped | List mapped task instances Get details of all mapped task instances. *New in version 2.3.0* TaskInstance |
GET | /dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/logs/{task_try_number} | Get logs Get logs for a specific task instance and its try number. TaskInstance |
PATCH | /dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/setNote | Update the TaskInstance note. Update the manual user note of a non-mapped Task Instance. *New in version 2.5. |
GET | /dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/xcomEntries | List XCom entries This endpoint allows specifying `~` as the dag_id, dag_run_id, task_id to retrieve XCOM entr |
GET | /dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/xcomEntries/{xcom_key} | Get an XCom entry XCom |
GET | /dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/{map_index} | Get a mapped task instance Get details of a mapped task instance. *New in version 2.3.0* TaskInstance |
PATCH | /dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/{map_index} | Updates the state of a mapped task instance Updates the state for single mapped task instance. *New in version |
PATCH | /dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/{map_index}/setNote | Update the TaskInstance note. Update the manual user note of a mapped Task Instance. *New in version 2.5.0* T |
GET | /dags/{dag_id}/dagRuns/{dag_run_id}/upstreamDatasetEvents | Get dataset events for a DAG run Get datasets for a dag run. *New in version 2.4.0* DAGRun Dataset |
GET | /dags/{dag_id}/details | Get a simplified representation of DAG The response contains many DAG attributes, so the response can be large |
GET | /dags/{dag_id}/tasks | Get tasks for DAG DAG |
GET | /dags/{dag_id}/tasks/{task_id} | Get simplified representation of a task DAG |
POST | /dags/{dag_id}/updateTaskInstancesState | Set a state of task instances Updates the state for multiple task instances simultaneously. DAG |
POST | /dags/~/dagRuns/list | List DAG runs (batch) This endpoint is a POST to allow filtering across a large number of DAG IDs, where as a |
and 33 more operation(s) in this specification, all searchable.
specification origin: https://airflow.apache.org/docs/apache-airflow/stable/_specs/v1.yaml
API for Qakka Queue System
| method | path | what the vendor says it does |
|---|---|---|
GET | /queues | Get list of all Queues. queues |
POST | /queues | Create new queue. queues |
DELETE | /queues/{queueName} | Delete Queue. queues |
GET | /queues/{queueName}/config | Get Queue config. queues |
PUT | /queues/{queueName}/config | Update Queue configuration. queues |
GET | /queues/{queueName}/data/{queueMessageId} | Get data associated with a Queue Message. queues |
GET | /queues/{queueName}/messages | Get next Queue Messages from a Queue queues |
POST | /queues/{queueName}/messages | Send Queue Message with a binary data (blob) payload. queues |
DELETE | /queues/{queueName}/messages/{queueMessageId} | Acknowledge that Queue Message has been processed. queues |
GET | /status | Status of webapp. status |
specification origin: https://raw.githubusercontent.com/apache/usergrid-qakka/master/docs/swagger.json
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.