@itentialopensource/adapter-apache_airflow

openapi: 3.0.0 info: title: Airflow API (Stable) description: > # 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 behavior as exceptions. ### Create To create a resource, you typically submit an HTTP `POST` request with the resource's required metadata in the request body. The response returns a `201 Created` response code upon success with the resource's metadata, including its internal `id`, in the response body. ### Read The HTTP `GET` request can be used to read a resource or to list a number of resources. A resource's `id` can be submitted in the request parameters to read a specific resource. The response usually returns a `200 OK` response code upon success, with the resource's metadata in the response body. If a `GET` request does not include a specific resource `id`, it is treated as a list request. The response usually returns a `200 OK` response code upon success, with an object containing a list of resources' metadata in the response body. When reading resources, some common query parameters are usually available. e.g.: ``` v1/connections?limit=25&offset=25 ``` |Query Parameter|Type|Description| |---------------|----|-----------| |limit|integer|Maximum number of objects to fetch. Usually 25 by default| |offset|integer|Offset after which to start returning objects. For use with limit query parameter.| ### Update Updating a resource requires the resource `id`, and is typically done using an HTTP `PATCH` request, with the fields to modify in the request body. The response usually returns a `200 OK` response code upon success, with information about the modified resource in the response body. ### Delete Deleting a resource requires the resource `id` and is typically executing via an HTTP `DELETE` request. The response usually returns a `204 No Content` response code upon success. ## Conventions - Resource names are plural and expressed in camelCase. - Names are consistent between URL parameter name and field name. - Field names are in snake_case. ```json { "name": "string", "slots": 0, "occupied_slots": 0, "used_slots": 0, "queued_slots": 0, "open_slots": 0 } ``` ### Update Mask Update mask is available as a query parameter in patch endpoints. It is used to notify the API which fields you want to update. Using `update_mask` makes it easier to update objects by helping the server know which fields to update in an object instead of updating all fields. The update request ignores any fields that aren't specified in the field mask, leaving them with their current values. Example: ``` resource = request.get('/resource/my-id').json() resource['my_field'] = 'new-value' request.patch('/resource/my-id?update_mask=my_field', data=json.dumps(resource)) ``` ## Versioning and Endpoint Lifecycle - API versioning is not synchronized to specific releases of the Apache Airflow. - APIs are designed to be backward compatible. - Any changes to the API will first go through a deprecation phase. # Summary of Changes | Airflow version | Description | |-|-| | v2.0 | Initial release | | v2.0.2 | Added /plugins endpoint | | v2.1 | New providers endpoint | # Trying the API You can use a third party client, such as [curl](https://curl.haxx.se/), [HTTPie](https://httpie.org/), [Postman](https://www.postman.com/) or [the Insomnia rest client](https://insomnia.rest/) to test the Apache Airflow API. Note that you will need to pass credentials data. For e.g., here is how to pause a DAG with [curl](https://curl.haxx.se/), when basic authorization is used: ```bash curl -X PATCH 'https://example.com/api/v1/dags/{dag_id}?update_mask=is_paused' \ -H 'Content-Type: application/json' \ --user "username:password" \ -d '{ "is_paused": true }' ``` Using a graphical tool such as [Postman](https://www.postman.com/) or [Insomnia](https://insomnia.rest/), it is possible to import the API specifications directly: 1. Download the API specification by clicking the **Download** button at top of this document 2. Import the JSON specification in the graphical tool of your choice. - In *Postman*, you can click the **import** button at the top - With *Insomnia*, you can just drag-and-drop the file on the UI Note that with *Postman*, you can also generate code snippets by selecting a request and clicking on the **Code** button. ## Enabling CORS [Cross-origin resource sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) is a browser security feature that restricts HTTP requests that are initiated from scripts running in the browser. For details on enabling/configuring CORS, see [Enabling CORS](https://airflow.apache.org/docs/apache-airflow/stable/security/api.html). # Authentication To be able to meet the requirements of many organizations, Airflow supports many authentication methods, and it is even possible to add your own method. If you want to check which auth backend is currently set, you can use `airflow config get-value api auth_backend` command as in the example below. ```bash $ airflow config get-value api auth_backend airflow.api.auth.backend.basic_auth ``` The default is to deny all requests. For details on configuring the authentication, see [API Authorization](https://airflow.apache.org/docs/apache-airflow/stable/security/api.html). # Errors We follow the error response format proposed in [RFC 7807](https://tools.ietf.org/html/rfc7807) also known as Problem Details for HTTP APIs. As with our normal API responses, your client must be prepared to gracefully handle additional members of the response. ## Unauthenticated This indicates that the request has not been applied because it lacks valid authentication credentials for the target resource. Please check that you have valid credentials. ## PermissionDenied This response means that the server understood the request but refuses to authorize it because it lacks sufficient rights to the resource. It happens when you do not have the necessary permission to execute the action you performed. You need to get the appropriate permissions in other to resolve this error. ## BadRequest This response means that the server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing). To resolve this, please ensure that your syntax is correct. ## NotFound This client error response indicates that the server cannot find the requested resource. ## MethodNotAllowed Indicates that the request method is known by the server but is not supported by the target resource. ## NotAcceptable The target resource does not have a current representation that would be acceptable to the user agent, according to the proactive negotiation header fields received in the request, and the server is unwilling to supply a default representation. ## AlreadyExists The request could not be completed due to a conflict with the current state of the target resource, e.g. the resource it tries to create already exists. ## Unknown This means that the server encountered an unexpected condition that prevented it from fulfilling the request. contact: name: Apache Software Foundation url: https://airflow.apache.org email: dev@airflow.apache.org version: '1.0.0' servers: - url: /api/v1 description: Apache Airflow Stable API. variables: {} paths: /config: get: tags: - Config summary: get_config description: Get current configuration operationId: get_config parameters: [] responses: '200': description: Success. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Config' - description: The configuration. example: sections: - name: core options: - key: dags_folder value: /home/user/my-dags-folder - name: smtp options: - key: smtp_host value: localhost - key: smtp_mail_from value: airflow@example.com example: sections: - name: core options: - key: dags_folder value: /home/user/my-dags-folder - name: smtp options: - key: smtp_host value: localhost - key: smtp_mail_from value: airflow@example.com text/plain: schema: type: string example: > [core] dags_folder = /home/user/my-dags-folder [smtp] smtp_host = localhost smtp_mail_from = airflow@example.com example: > [core] dags_folder = /home/user/my-dags-folder [smtp] smtp_host = localhost smtp_mail_from = airflow@example.com '401': description: Request not authenticated due to missing, invalid, authentication info. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' - description: '[RFC7807](https://tools.ietf.org/html/rfc7807) compliant response.' '403': description: Client does not have sufficient permission. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' - description: '[RFC7807](https://tools.ietf.org/html/rfc7807) compliant response.' deprecated: false /connections: get: tags: - Connection summary: get_connections description: List connections operationId: get_connections parameters: - name: limit in: query description: The numbers of items to return. style: form explode: true schema: type: integer format: int32 default: 100 - name: offset in: query description: The number of items to skip before starting to collect the result set. style: form explode: true schema: minimum: 0 type: integer format: int32 - name: order_by in: query description: >- The name of the field to order the results by. Prefix a field name with `-` to reverse the sort order. style: form explode: true schema: type: string responses: '200': description: Success. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/ConnectionCollection' - description: Collection of connections. '401': description: Request not authenticated due to missing, invalid, authentication info. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' - description: '[RFC7807](https://tools.ietf.org/html/rfc7807) compliant response.' '403': description: Client does not have sufficient permission. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' - description: '[RFC7807](https://tools.ietf.org/html/rfc7807) compliant response.' deprecated: false post: tags: - Connection summary: post_connection description: Create a connection operationId: post_connection parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/Connection' required: true responses: '200': description: Success. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Connection' - description: Full representation of the connection. '400': description: Client specified an invalid argument. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' - description: '[RFC7807](https://tools.ietf.org/html/rfc7807) compliant response.' '401': description: Request not authenticated due to missing, invalid, authentication info. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' - description: '[RFC7807](https://tools.ietf.org/html/rfc7807) compliant response.' '403': description: Client does not have sufficient permission. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' - description: '[RFC7807](https://tools.ietf.org/html/rfc7807) compliant response.' deprecated: false /connections/{connection_id}: get: tags: - Connection summary: get_connection description: Get a connection operationId: get_connection parameters: - name: connection_id in: path description: The connection ID. required: true style: simple schema: type: string responses: '200': description: Success. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Connection' - description: Full representation of the connection. '401': description: Request not authenticated due to missing, invalid, authentication info. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' - description: '[RFC7807](https://tools.ietf.org/html/rfc7807) compliant response.' '403': description: Client does not have sufficient permission. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' - description: '[RFC7807](https://tools.ietf.org/html/rfc7807) compliant response.' '404': description: A specified resource is not found. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' - description: '[RFC7807](https://tools.ietf.org/html/rfc7807) compliant response.' deprecated: false patch: tags: - Connection summary: patch_connection description: Update a connection operationId: patch_connection parameters: - name: connection_id in: path description: The connection ID. required: true style: simple schema: type: string - name: update_mask in: query description: >- The fields to update on the resource. If absent or empty, all modifiable fields are updated. A comma-separated list of fully qualified names of fields. style: form explode: true schema: type: array items: type: string requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/Connection' required: true responses: '200': description: Success. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Connection' - description: Full representation of the connection. '400': description: Client specified an invalid argument. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' - description: '[RFC7807](https://tools.ietf.org/html/rfc7807) compliant response.' '401': description: Request not authenticated due to missing, invalid, authentication info. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' - description: '[RFC7807](https://tools.ietf.org/html/rfc7807) compliant response.' '403': description: Client does not have sufficient permission. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' - description: '[RFC7807](https://tools.ietf.org/html/rfc7807) compliant response.' '404': description: A specified resource is not found. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' - description: '[RFC7807](https://tools.ietf.org/html/rfc7807) compliant response.' deprecated: false delete: tags: - Connection summary: delete_connection description: Delete a connection operationId: delete_connection parameters: - name: connection_id in: path description: The connection ID. required: true style: simple schema: type: string responses: '204': description: Success. headers: {} content: {} '400': description: Client specified an invalid argument. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' - description: '[RFC7807](https://tools.ietf.org/html/rfc7807) compliant response.' '401': description: Request not authenticated due to missing, invalid, authentication info. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' - description: '[RFC7807](https://tools.ietf.org/html/rfc7807) compliant response.' '403': description: Client does not have sufficient permission. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' - description: '[RFC7807](https://tools.ietf.org/html/rfc7807) compliant response.' '404': description: A specified resource is not found. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' - description: '[RFC7807](https://tools.ietf.org/html/rfc7807) compliant response.' deprecated: false /connections/test: post: tags: - Connection summary: test_connection description: Test a connection operationId: test_connection parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/Connection' required: true responses: '200': description: Success. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/ConnectionTest' - description: Connection test results. '400': description: Client specified an invalid argument. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' - description: '[RFC7807](https://tools.ietf.org/html/rfc7807) compliant response.' '401': description: Request not authenticated due to missing, invalid, authentication info. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' - description: '[RFC7807](https://tools.ietf.org/html/rfc7807) compliant response.' '403': description: Client does not have sufficient permission. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' - description: '[RFC7807](https://tools.ietf.org/html/rfc7807) compliant response.' '404': description: A specified resource is not found. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' - description: '[RFC7807](https://tools.ietf.org/html/rfc7807) compliant response.' deprecated: false /dags: get: tags: - DAG summary: get_dags description: List DAGs operationId: get_dags parameters: - name: limit in: query description: The numbers of items to return. style: form explode: true schema: type: integer format: int32 default: 100 - name: offset in: query description: The number of items to skip before starting to collect the result set. style: form explode: true schema: minimum: 0 type: integer format: int32 - name: order_by in: query description: >- The name of the field to order the results by. Prefix a field name with `-` to reverse the sort order. style: form explode: true schema: type: string - name: tags in: query description: List of tags to filter results style: form explode: true schema: type: array items: type: string - name: only_active in: query description: Only return active DAGs. style: form explode: true schema: type: boolean default: true responses: '200': description: Success. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/DAGCollection' - description: Collection of DAGs. '401': description: Request not authenticated due to missing, invalid, authentication info. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' - description: '[RFC7807](https://tools.ietf.org/html/rfc7807) compliant response.' deprecated: false /dags/{dag_id}: get: tags: - DAG summary: get_dag description: > Presents only information available in database (DAGModel). If you need detailed information, consider using GET /dags/{dag_id}/details. operationId: get_dag parameters: - name: dag_id in: path description: The DAG ID. required: true style: simple schema: type: string responses: '200': description: Success. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/DAG' - description: DAG '401': description: Request not authenticated due to missing, invalid, authentication info. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' - description: '[RFC7807](https://tools.ietf.org/html/rfc7807) compliant response.' '403': description: Client does not have sufficient permission. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' - description: '[RFC7807](https://tools.ietf.org/html/rfc7807) compliant response.' '404': description: A specified resource is not found. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' - description: '[RFC7807](https://tools.ietf.org/html/rfc7807) compliant response.' deprecated: false patch: tags: - DAG summary: patch_dag description: Update a DAG operationId: patch_dag parameters: - name: dag_id in: path description: The DAG ID. required: true style: simple schema: type: string - name: update_mask in: query description: >- The fields to update on the resource. If absent or empty, all modifiable fields are updated. A comma-separated list of fully qualified names of fields. style: form explode: true schema: type: array items: type: string requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/DAG' required: true responses: '200': description: Success. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/DAG' - description: DAG '401': description: Request not authenticated due to missing, invalid, authentication info. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' - description: '[RFC7807](https://tools.ietf.org/html/rfc7807) compliant response.' '403': description: Client does not have sufficient permission. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' - description: '[RFC7807](https://tools.ietf.org/html/rfc7807) compliant response.' '404': description: A specified resource is not found. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' - description: '[RFC7807](https://tools.ietf.org/html/rfc7807) compliant response.' deprecated: false delete: tags: - DAG summary: delete_dag description: > Deletes all metadata related to the DAG, including finished DAG Runs and Tasks. Logs are not deleted. This action cannot be undone. operationId: delete_dag parameters: - name: dag_id in: path description: The DAG ID. required: true style: simple schema: type: string responses: '204': description: Success. headers: {} content: {} '400': description: Client specified an invalid argument. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' - description: '[RFC7807](https://tools.ietf.org/html/rfc7807) compliant response.' '401': description: Request not authenticated due to missing, invalid, authentication info. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' - description: '[RFC7807](https://tools.ietf.org/html/rfc7807) compliant response.' '403': description: Client does not have sufficient permission. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' - description: '[RFC7807](https://tools.ietf.org/html/rfc7807) compliant response.' '404': description: A specified resource is not found. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' - description: '[RFC7807](https://tools.ietf.org/html/rfc7807) compliant response.' '409': description: An existing resource conflicts with the request. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' - description: '[RFC7807](https://tools.ietf.org/html/rfc7807) compliant response.' deprecated: false /dags/{dag_id}/clearTaskInstances: post: tags: - DAG summary: post_clear_task_instances description: > Clears a set of task instances associated with the DAG for a specified date range. operationId: post_clear_task_instances parameters: - name: dag_id in: path description: The DAG ID. required: true style: simple schema: type: string requestBody: description: Parameters of action content: application/json: schema: allOf: - $ref: '#/components/schemas/ClearTaskInstance' - description: Parameters of action required: true responses: '200': description: Success. headers: {} content: application/json: schema: $ref: '#/components/schemas/TaskInstanceReferenceCollection' '401': description: Request not authenticated due to missing, invalid, authentication info. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' - description: '[RFC7807](https://tools.ietf.org/html/rfc7807) compliant response.' '403': description: Client does not have sufficient permission. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' - description: '[RFC7807](https://tools.ietf.org/html/rfc7807) compliant response.' '404': description: A specified resource is not found. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' - description: '[RFC7807](https://tools.ietf.org/html/rfc7807) compliant response.' deprecated: false /dags/{dag_id}/updateTaskInstancesState: post: tags: - DAG summary: post_set_task_instances_state description: > Updates the state for multiple task instances simultaneously. operationId: post_set_task_instances_state parameters: - name: dag_id in: path description: The DAG ID. required: true style: simple schema: type: string requestBody: description: Parameters of action content: application/json: schema: allOf: - $ref: '#/components/schemas/UpdateTaskInstancesState' - description: Parameters of action required: true responses: '200': description: Success. headers: {} content: application/json: schema: $ref: '#/components/schemas/TaskInstanceReferenceCollection' '401': description: Request not authenticated due to missing, invalid, authentication info. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' - description: '[RFC7807](https://tools.ietf.org/html/rfc7807) compliant response.' '403': description: Client does not have sufficient permission. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' - description: '[RFC7807](https://tools.ietf.org/html/rfc7807) compliant response.' '404': description: A specified resource is not found. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' - description: '[RFC7807](https://tools.ietf.org/html/rfc7807) compliant response.' deprecated: false /dags/{dag_id}/details: get: tags: - DAG summary: get_dag_details description: > The response contains many DAG attributes, so the response can be large. If possible, consider using GET /dags/{dag_id}. operationId: get_dag_details parameters: - name: dag_id in: path description: The DAG ID. required: true style: simple schema: type: string responses: '200': description: Success. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/DAGDetail' - description: >- DAG details. For details see: (airflow.models.DAG)[https://airflow.apache.org/docs/apache-airflow/stable/_api/airflow/models/index.html#airflow.models.DAG] '401': description: Request not authenticated due to missing, invalid, authentication info. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' - description: '[RFC7807](https://tools.ietf.org/html/rfc7807) compliant response.' '403': description: Client does not have sufficient permission. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' - description: '[RFC7807](https://tools.ietf.org/html/rfc7807) compliant response.' '404': description: A specified resource is not found. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' - description: '[RFC7807](https://tools.ietf.org/html/rfc7807) compliant response.' deprecated: false /dags/{dag_id}/tasks: get: tags: - DAG summary: get_tasks description: Get tasks for DAG operationId: get_tasks parameters: - name: dag_id in: path description: The DAG ID. required: true style: simple schema: type: string - name: order_by in: query description: >- The name of the field to order the results by. Prefix a field name with `-` to reverse the sort order. style: form explode: true schema: type: string responses: '200': description: Success. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/TaskCollection' - description: Collection of tasks. '401': description: Request not authenticated due to missing, invalid, authentication info. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' - description: '[RFC7807](https://tools.ietf.org/html/rfc7807) compliant response.' '403': description: Client does not have sufficient permission. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' - description: '[RFC7807](https://tools.ietf.org/html/rfc7807) compliant response.' '404': description: A specified resource is not found. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' - description: '[RFC7807](https://tools.ietf.org/html/rfc7807) compliant response.' deprecated: false /dags/{dag_id}/tasks/{task_id}: get: tags: - DAG summary: get_task description: Get simplified representation of a task operationId: get_task parameters: - name: dag_id in: path description: The DAG ID. required: true style: simple schema: type: string - name: task_id in: path description: The task ID. required: true style: simple schema: type: string responses: '200': description: Success. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Task' - description: >- For details see: (airflow.models.BaseOperator)[https://airflow.apache.org/docs/apache-airflow/stable/_api/airflow/models/index.html#airflow.models.BaseOperator] '401': description: Request not authenticated due to missing, invalid, authentication info. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' - description: '[RFC7807](https://tools.ietf.org/html/rfc7807) compliant response.' '403': description: Client does not have sufficient permission. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' - description: '[RFC7807](https://tools.ietf.org/html/rfc7807) compliant response.' '404': description: A specified resource is not found. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' - description: '[RFC7807](https://tools.ietf.org/html/rfc7807) compliant response.' deprecated: false /dagSources/{file_token}: get: tags: - DAG summary: get_dag_source description: > Get a source code using file token. operationId: get_dag_source parameters: - name: file_token in: path description: >- The key containing the encrypted path to the file. Encryption and decryption take place only on the server. This prevents the client from reading an non-DAG file. This also ensures API extensibility, because the format of encrypted data may change. required: true style: simple schema: type: string responses: '200': description: Success. headers: {} content: application/json: schema: $ref: '#/components/schemas/DagSourcesResponse' plain/text: schema: {} '401': description: Request not authenticated due to missing, invalid, authentication info. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' - description: '[RFC7807](https://tools.ietf.org/html/rfc7807) compliant response.' '403': description: Client does not have sufficient permission. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' - description: '[RFC7807](https://tools.ietf.org/html/rfc7807) compliant response.' '404': description: A specified resource is not found. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' - description: '[RFC7807](https://tools.ietf.org/html/rfc7807) compliant response.' '406': description: A specified Accept header is not allowed. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' - description: '[RFC7807](https://tools.ietf.org/html/rfc7807) compliant response.' deprecated: false /dags/{dag_id}/dagRuns: get: tags: - DAGRun summary: get_dag_runs description: > This endpoint allows specifying `~` as the dag_id to retrieve DAG runs for all DAGs. operationId: get_dag_runs parameters: - name: dag_id in: path description: The DAG ID. required: true style: simple schema: type: string - name: limit in: query description: The numbers of items to return. style: form explode: true schema: type: integer format: int32 default: 100 - name: offset in: query description: The number of items to skip before starting to collect the result set. style: form explode: true schema: minimum: 0 type: integer format: int32 - name: execution_date_gte in: query description: >- Returns objects greater or equal to the specified date. This can be combined with execution_date_lte parameter to receive only the selected period. style: form explode: true schema: type: string format: date-time - name: execution_date_lte in: query description: >- Returns objects less than or equal to the specified date. This can be combined with execution_date_gte parameter to receive only the selected period. style: form explode: true schema: type: string format: date-time - name: start_date_gte in: query description: >- Returns objects greater or equal the specified date. This can be combined with start_date_lte parameter to receive only the selected period. style: form explode: true schema: type: string format: date-time - name: start_date_lte in: query description: >- Returns objects less or equal the specified date. This can be combined with start_date_gte parameter to receive only the selected period. style: form explode: true schema: type: string format: date-time - name: end_date_gte in: query description: >- Returns objects greater or equal the specified date. This can be combined with start_date_lte parameter to receive only the selected period. style: form explode: true schema: type: string format: date-time - name: end_date_lte in: query description: >- Returns objects less than or equal to the specified date. This can be combined with start_date_gte parameter to receive only the selected period. style: form explode: true schema: type: string format: date-time - name: order_by in: query description: >- The name of the field to order the results by. Prefix a field name with `-` to reverse the sort order. style: form explode: true schema: type: string responses: '200': description: List of DAG runs. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/DAGRunCollection' - description: Collection of DAG runs. '401': description: Request not authenticated due to missing, invalid, authentication info. headers: {}