All URIs are relative to http://localhost
| Method | HTTP request | Description |
|---|---|---|
| get_dag_version | GET /api/v2/dags/{dag_id}/dagVersions/{version_number} | Get Dag Version |
| get_dag_version_diff | GET /api/v2/dags/{dag_id}/dagVersions/diff | Experimental: Compare what two stored versions of a Dag currently hold. |
| get_dag_versions | GET /api/v2/dags/{dag_id}/dagVersions | Get Dag Versions |
DagVersionResponse get_dag_version(dag_id, version_number)
Get Dag Version
Get one Dag Version.
import airflow_client.client from airflow_client.client.models.dag_version_response import DagVersionResponse from airflow_client.client.rest import ApiException from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = airflow_client.client.Configuration( host = "http://localhost" ) # The client must configure the authentication and authorization parameters # in accordance with the API server security policy. # Examples for each auth method are provided below, use the example that # satisfies your auth use case. configuration.access_token = os.environ["ACCESS_TOKEN"] # Configure Bearer authorization: HTTPBearer configuration = airflow_client.client.Configuration( access_token = os.environ["BEARER_TOKEN"] ) # Enter a context with an instance of the API client with airflow_client.client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = airflow_client.client.DagVersionApi(api_client) dag_id = 'dag_id_example' # str | version_number = 56 # int | try: # Get Dag Version api_response = api_instance.get_dag_version(dag_id, version_number) print("The response of DagVersionApi->get_dag_version:\n") pprint(api_response) except Exception as e: print("Exception when calling DagVersionApi->get_dag_version: %s\n" % e)
| Name | Type | Description | Notes |
|---|---|---|---|
| dag_id | str | ||
| version_number | int |
OAuth2PasswordBearer, HTTPBearer
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful Response | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 422 | Validation Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DagVersionDiffResponse get_dag_version_diff(dag_id, base_version_number, target_version_number, max_changes=max_changes)
Experimental: Compare what two stored versions of a Dag currently hold.
🚧 This is an experimental endpoint and may change or be removed without notice.
Reports observed state — what the two stored versions currently hold — not why a version was created. Version access returns the changed structure with identifying path components masked; the raw values behind those changes, and the paths that name them, are disclosed only to a caller who may also read the Dag's code.
import airflow_client.client from airflow_client.client.models.dag_version_diff_response import DagVersionDiffResponse from airflow_client.client.rest import ApiException from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = airflow_client.client.Configuration( host = "http://localhost" ) # The client must configure the authentication and authorization parameters # in accordance with the API server security policy. # Examples for each auth method are provided below, use the example that # satisfies your auth use case. configuration.access_token = os.environ["ACCESS_TOKEN"] # Configure Bearer authorization: HTTPBearer configuration = airflow_client.client.Configuration( access_token = os.environ["BEARER_TOKEN"] ) # Enter a context with an instance of the API client with airflow_client.client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = airflow_client.client.DagVersionApi(api_client) dag_id = 'dag_id_example' # str | base_version_number = 56 # int | Version to compare from. target_version_number = 56 # int | Version to compare to. max_changes = 500 # int | Largest number of records `changes` may hold. A repeat of a path already recorded does not count towards it, and `truncated` says whether the bound dropped anything. (optional) (default to 500) try: # Experimental: Compare what two stored versions of a Dag currently hold. api_response = api_instance.get_dag_version_diff(dag_id, base_version_number, target_version_number, max_changes=max_changes) print("The response of DagVersionApi->get_dag_version_diff:\n") pprint(api_response) except Exception as e: print("Exception when calling DagVersionApi->get_dag_version_diff: %s\n" % e)
| Name | Type | Description | Notes |
|---|---|---|---|
| dag_id | str | ||
| base_version_number | int | Version to compare from. | |
| target_version_number | int | Version to compare to. | |
| max_changes | int | Largest number of records `changes` may hold. A repeat of a path already recorded does not count towards it, and `truncated` says whether the bound dropped anything. | [optional] [default to 500] |
OAuth2PasswordBearer, HTTPBearer
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful Response | - |
| 400 | Bad Request | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 422 | Validation Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DAGVersionCollectionResponse get_dag_versions(dag_id, limit=limit, offset=offset, version_number=version_number, bundle_name=bundle_name, bundle_version=bundle_version, order_by=order_by)
Get Dag Versions
Get all Dag Versions.
This endpoint allows specifying ~ as the dag_id to retrieve Dag Versions for all Dags.
import airflow_client.client from airflow_client.client.models.dag_version_collection_response import DAGVersionCollectionResponse from airflow_client.client.rest import ApiException from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = airflow_client.client.Configuration( host = "http://localhost" ) # The client must configure the authentication and authorization parameters # in accordance with the API server security policy. # Examples for each auth method are provided below, use the example that # satisfies your auth use case. configuration.access_token = os.environ["ACCESS_TOKEN"] # Configure Bearer authorization: HTTPBearer configuration = airflow_client.client.Configuration( access_token = os.environ["BEARER_TOKEN"] ) # Enter a context with an instance of the API client with airflow_client.client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = airflow_client.client.DagVersionApi(api_client) dag_id = 'dag_id_example' # str | limit = 50 # int | (optional) (default to 50) offset = 0 # int | (optional) (default to 0) version_number = 56 # int | (optional) bundle_name = 'bundle_name_example' # str | (optional) bundle_version = 'bundle_version_example' # str | (optional) order_by = ["id"] # List[str] | Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `id, version_number, bundle_name, bundle_version` (optional) (default to ["id"]) try: # Get Dag Versions api_response = api_instance.get_dag_versions(dag_id, limit=limit, offset=offset, version_number=version_number, bundle_name=bundle_name, bundle_version=bundle_version, order_by=order_by) print("The response of DagVersionApi->get_dag_versions:\n") pprint(api_response) except Exception as e: print("Exception when calling DagVersionApi->get_dag_versions: %s\n" % e)
| Name | Type | Description | Notes |
|---|---|---|---|
| dag_id | str | ||
| limit | int | [optional] [default to 50] | |
| offset | int | [optional] [default to 0] | |
| version_number | int | [optional] | |
| bundle_name | str | [optional] | |
| bundle_version | str | [optional] | |
| order_by | List[str] | Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `id, version_number, bundle_name, bundle_version` | [optional] [default to ["id"]] |
OAuth2PasswordBearer, HTTPBearer
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful Response | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 422 | Validation Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]