action POST v1.0.0
Clear a DAG run.
*New in version 2.4.0*
swirls add apache clear_dag_run Source action POST v1.0.0
Clears a set of task instances associated with the DAG for a specified date range.
swirls add apache post_clear_task_instances Source action POST v1.0.0
swirls add apache post_connection Source action POST v1.0.0
swirls add apache post_pool Source action POST v1.0.0
Create a new role.
*New in version 2.1.0*
swirls add apache post_role Source action POST v1.0.0
Create a new user with unique username and email.
*New in version 2.2.0*
swirls add apache post_user Source action POST v1.0.0
swirls add apache post_variables Source action DELETE v1.0.0
swirls add apache delete_connection Source action DELETE v1.0.0
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*
swirls add apache delete_dag Source action DELETE v1.0.0
swirls add apache delete_dag_run Source action DELETE v1.0.0
swirls add apache delete_pool Source action DELETE v1.0.0
Delete a role.
*New in version 2.1.0*
swirls add apache delete_role Source action DELETE v1.0.0
Delete a user with a specific username.
*New in version 2.2.0*
swirls add apache delete_user Source action DELETE v1.0.0
swirls add apache delete_variable Source action GET v1.0.0
swirls add apache get_connection Source action GET v1.0.0
swirls add apache get_dag_run Source action GET v1.0.0
Get a dataset by uri.
swirls add apache get_dataset Source action GET v1.0.0
Get a list of loaded plugins.
*New in version 2.1.0*
swirls add apache get_plugins Source action GET v1.0.0
swirls add apache get_event_log Source action GET v1.0.0
Get details of a mapped task instance.
*New in version 2.3.0*
swirls add apache get_mapped_task_instance Source action GET v1.0.0
swirls add apache get_pool Source action GET v1.0.0
Get a role.
*New in version 2.1.0*
swirls add apache get_role Source action GET v1.0.0
The response contains many DAG attributes, so the response can be large. If possible, consider using GET /dags/{dag_id}.
swirls add apache get_dag_details Source action GET v1.0.0
Get a source code using file token.
swirls add apache get_dag_source Source action GET v1.0.0
swirls add apache get_task_instance Source action GET v1.0.0
Get a user with a specific username.
*New in version 2.1.0*
swirls add apache get_user Source action GET v1.0.0
Get a variable by key.
swirls add apache get_variable Source action GET v1.0.0
swirls add apache get_xcom_entry Source action GET v1.0.0
Presents only information available in database (DAGModel).
If you need detailed information, consider using GET /dags/{dag_id}/details.
swirls add apache get_dag Source action GET v1.0.0
swirls add apache get_config Source action GET v1.0.0
Get dataset events
swirls add apache get_dataset_events Source action GET v1.0.0
Get datasets for a dag run.
*New in version 2.4.0*
swirls add apache get_upstream_dataset_events Source action GET v1.0.0
Get logs for a specific task instance and its try number.
swirls add apache get_log Source action GET v1.0.0
swirls add apache get_task Source action GET v1.0.0
swirls add apache get_tasks Source action GET v1.0.0
swirls add apache get_connections Source action GET v1.0.0
This endpoint allows specifying `~` as the dag_id to retrieve DAG runs for all DAGs.
swirls add apache get_dag_runs Source action GET v1.0.0
swirls add apache get_dag_warnings Source action GET v1.0.0
List DAGs in the database.
`dag_id_pattern` can be set to match dags of a specific pattern
swirls add apache get_dags Source action GET v1.0.0
swirls add apache get_datasets Source action GET v1.0.0
List extra links for task instance.
swirls add apache get_extra_links Source action GET v1.0.0
List log entries from event log.
swirls add apache get_event_logs Source action GET v1.0.0
Get details of all mapped task instances.
*New in version 2.3.0*
swirls add apache get_mapped_task_instances Source action GET v1.0.0
Get a list of permissions.
*New in version 2.1.0*
swirls add apache get_permissions Source action GET v1.0.0
swirls add apache get_pools Source action GET v1.0.0
Get a list of providers.
*New in version 2.1.0*
swirls add apache get_providers Source action GET v1.0.0
Get a list of roles.
*New in version 2.1.0*
swirls add apache get_roles Source action GET v1.0.0
This endpoint allows specifying `~` as the dag_id, dag_run_id to retrieve DAG runs for all DAGs and DAG runs.
swirls add apache get_task_instances Source action GET v1.0.0
Get a list of users.
*New in version 2.1.0*
swirls add apache get_users Source action GET v1.0.0
The collection does not contain data. To get data, you must get a single entity.
swirls add apache get_variables Source action GET v1.0.0
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.
swirls add apache get_xcom_entries Source action PATCH v1.0.0
Modify a DAG run.
*New in version 2.2.0*
swirls add apache update_dag_run_state Source action POST v1.0.0
Updates the state for multiple task instances simultaneously.
swirls add apache post_set_task_instances_state Source action POST v1.0.0
Test a connection.
*New in version 2.2.0*
swirls add apache test_connection Source action POST v1.0.0
swirls add apache post_dag_run Source action PATCH v1.0.0
swirls add apache patch_connection Source action PATCH v1.0.0
swirls add apache patch_dag Source action PATCH v1.0.0
swirls add apache patch_pool Source action PATCH v1.0.0
Update a role.
*New in version 2.1.0*
swirls add apache patch_role Source action PATCH v1.0.0
Update fields for a user.
*New in version 2.2.0*
swirls add apache patch_user Source action PATCH v1.0.0
Update a variable by key.
swirls add apache patch_variable Source action PATCH v1.0.0
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*
swirls add apache patch_dags Source action PATCH v1.0.0
Update the manual user note of a DagRun.
*New in version 2.5.0*
swirls add apache set_dag_run_note Source action PATCH v1.0.0
Update the manual user note of a mapped Task Instance.
*New in version 2.5.0*
swirls add apache set_mapped_task_instance_note Source action PATCH v1.0.0
Update the manual user note of a non-mapped Task Instance.
*New in version 2.5.0*
swirls add apache set_task_instance_note Source action PATCH v1.0.0
Updates the state for single mapped task instance.
*New in version 2.5.0*
swirls add apache patch_mapped_task_instance Source action PATCH v1.0.0
Updates the state for single task instance.
*New in version 2.5.0*
swirls add apache patch_task_instance Source