Apache Airflow REST API
Mock the Apache Airflow REST API in seconds. Overview To facilitate management, Apache Airflow supports a range of REST API endpoints across its objects.
[01]
About
Mock the Apache Airflow REST API as a turnkey Mockzilla sim with 73 OpenAPI endpoints, realistic JSON payloads, no upstream signup or sandbox keys. Overview To facilitate management, Apache Airflow supports a range of REST API endpoints across its objects. Methods: 41x GET, 13x PATCH, 12x POST, 7x DELETE. Top resource groups: DAG, TaskInstance, DAGRun, Connection. Hit https://api.justmocks.com/apache-airflow for the Mockzilla API Explorer landing and per-endpoint sample requests.
Endpoints
73 across 18 resource groups
Methods
GET 41 · POST 12 · PATCH 13 · DEL 7 none deprecated
OpenAPI
3.0.3 spec version 2.5.3
Source spec
141 KB · YAML
view raw →
[02]
Endpoints
| GET |
/config
|
Get current configuration
|
| GET |
/connections
|
List connections
|
| POST |
/connections
|
Create a connection
|
| POST |
/connections/test
|
Test a connection Test a connection. New in version 2.2.0. Mocked via Mockzilla.
|
| DEL |
/connections/{connection_id}
|
Delete a connection
|
| GET |
/connections/{connection_id}
|
Get a connection
|
| PATCH |
/connections/{connection_id}
|
Update a connection
|
| GET |
/dagSources/{file_token}
|
Get a source code Get a source code using file token.
|
| GET |
/dagWarnings
|
List dag warnings
|
| GET |
/dags
|
List DAGs List DAGs in the database. dag_id_pattern can be set to match dags of a specific pattern
|
| PATCH |
/dags
|
Update DAGs Update DAGs of a given dag_id_pattern using UpdateMask. This endpoint allows specifying ~ as the dag_id_pattern to update all DAGs. New in version 2.3.0
|
| DEL |
/dags/{dag_id}
|
Delete a DAG Deletes all metadata related to the DAG, including finished DAG Runs and Tasks. Logs are not deleted. This action cannot be undone. New in version 2.2.0
|
| GET |
/dags/{dag_id}
|
Get basic information about a DAG Presents only information available in database (DAGModel). If you need detailed information, consider using GET /dags/{dag_id}/details. Available as a Mockzilla mock endpoint.
|
| PATCH |
/dags/{dag_id}
|
Update a DAG
|
| 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 range.
|
| GET |
/dags/{dag_id}/dagRuns
|
List DAG runs This endpoint allows specifying ~ as the dag_id to retrieve DAG runs for all DAGs.
|
| POST |
/dags/{dag_id}/dagRuns
|
Trigger a new DAG run
|
| DEL |
/dags/{dag_id}/dagRuns/{dag_run_id}
|
Delete a DAG run
|
| GET |
/dags/{dag_id}/dagRuns/{dag_run_id}
|
Get a DAG run
|
| PATCH |
/dags/{dag_id}/dagRuns/{dag_run_id}
|
Modify a DAG run Modify a DAG run. New in version 2.2.0
|
| POST |
/dags/{dag_id}/dagRuns/{dag_run_id}/clear
|
Clear a DAG run Clear a DAG run. New in version 2.4.0
|
| 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. Mockzilla mock: no signup, no API key.
|
| 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 DAGs and DAG runs.
|
| GET |
/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}
|
Get a task instance
|
| 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
|
| GET |
/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/links
|
List extra links List extra links for task instance.
|
| 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
|
| 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. Served by the Mockzilla mock runtime.
|
| 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.0
|
| 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 entries for for all DAGs, DAG runs and task instances. XCom values won't be returned as they can be large. Use this endpoint to get a list of XCom entries and then fetch individual entry to get value.
|
| GET |
/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/xcomEntries/{xcom_key}
|
Get an XCom entry
|
| 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
|
| 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 2.5.0
|
| 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. Mocked via Mockzilla.
|
| 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
|
| GET |
/dags/{dag_id}/details
|
Get a simplified representation of DAG The response contains many DAG attributes, so the response can be large. If possible, consider using GET /dags/{dag_id}.
|
| GET |
/dags/{dag_id}/tasks
|
Get tasks for DAG
|
| GET |
/dags/{dag_id}/tasks/{task_id}
|
Get simplified representation of a task
|
| POST |
/dags/{dag_id}/updateTaskInstancesState
|
Set a state of task instances Updates the state for multiple task instances simultaneously.
|
| 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 GET it would run in to maximum HTTP request URL length limit.
|
| POST |
/dags/~/dagRuns/~/taskInstances/list
|
List task instances (batch) List task instances from all DAGs and DAG runs. This endpoint is a POST to allow filtering across a large number of DAG IDs, where as a GET it would run in to maximum HTTP request URL length limits. Available as a Mockzilla mock endpoint.
|
| GET |
/datasets
|
List datasets
|
| GET |
/datasets/events
|
Get dataset events Get dataset events
|
| GET |
/datasets/{uri}
|
Get a dataset Get a dataset by uri.
|
| GET |
/eventLogs
|
List log entries List log entries from event log.
|
| GET |
/eventLogs/{event_log_id}
|
Get a log entry
|
| GET |
/health
|
Get instance status Get the status of Airflow's metadatabase and scheduler. It includes info about metadatabase and last heartbeat of scheduler.
|
| GET |
/importErrors
|
List import errors
|
| GET |
/importErrors/{import_error_id}
|
Get an import error
|
| GET |
/permissions
|
List permissions Get a list of permissions. New in version 2.1.0. Mockzilla mock: no signup, no API key.
|
| GET |
/plugins
|
Get a list of loaded plugins Get a list of loaded plugins. New in version 2.1.0
|
| GET |
/pools
|
List pools
|
| POST |
/pools
|
Create a pool
|
| DEL |
/pools/{pool_name}
|
Delete a pool
|
| GET |
/pools/{pool_name}
|
Get a pool
|
| PATCH |
/pools/{pool_name}
|
Update a pool
|
| GET |
/providers
|
List providers Get a list of providers. New in version 2.1.0
|
| GET |
/roles
|
List roles Get a list of roles. New in version 2.1.0
|
| POST |
/roles
|
Create a role Create a new role. New in version 2.1.0
|
| DEL |
/roles/{role_name}
|
Delete a role Delete a role. New in version 2.1.0. Served by the Mockzilla mock runtime.
|
| GET |
/roles/{role_name}
|
Get a role Get a role. New in version 2.1.0
|
| PATCH |
/roles/{role_name}
|
Update a role Update a role. New in version 2.1.0
|
| GET |
/users
|
List users Get a list of users. New in version 2.1.0
|
| POST |
/users
|
Create a user Create a new user with unique username and email. New in version 2.2.0
|
| DEL |
/users/{username}
|
Delete a user Delete a user with a specific username. New in version 2.2.0. Mocked via Mockzilla.
|
| GET |
/users/{username}
|
Get a user Get a user with a specific username. New in version 2.1.0
|
| PATCH |
/users/{username}
|
Update a user Update fields for a user. New in version 2.2.0
|
| GET |
/variables
|
List variables The collection does not contain data. To get data, you must get a single entity.
|
| POST |
/variables
|
Create a variable
|
| DEL |
/variables/{variable_key}
|
Delete a variable
|
| GET |
/variables/{variable_key}
|
Get a variable Get a variable by key.
|
| PATCH |
/variables/{variable_key}
|
Update a variable Update a variable by key. Available as a Mockzilla mock endpoint.
|
| GET |
/version
|
Get version information
|
[03]
Related mocks
Open-Meteo Air Quality API
Simulate the Open-Meteo Air Quality API with 1 endpoints without keys, sandboxes, or a live account.
1 endpoints
·
ai, data, developer, devtools, weather
BC Data Catalogue API
Emulate the BC Data Catalogue API in seconds. This API provides live access to the BC Data Catalogue.
22 endpoints
·
ai, content, data, government, search
BC Geographical Names Web Service
Emulate the BC Geographical Names Web Service with 14 endpoints without keys, sandboxes, or a live account.
14 endpoints
·
ai, data, geo, government, location