Apache Airflow DAG API

openapi: 3.2.0
info:
  contact:
    email: dev@airflow.apache.org
    name: Apache Software Foundation
    url: https://airflow.apache.org
    x-twitter: TheASF
  description: "# Overview\n\nTo facilitate management, Apache Airflow supports a range of REST API endpoints across its\nobjects.\nThis section provides an overview of the API design, methods, and supported use cases.\n\nMost of the endpoints accept `JSON` as input and return `JSON` responses.\nThis means that you must usually add the following headers to your request:\n```\nContent-type: application/json\nAccept: application/json\n```\n\n## Resources\n\nThe term `resource` refers to a single type of object in the Airflow metadata. An API is broken up by its\nendpoint's corresponding resource.\nThe name of a resource is typically plural and expressed in camelCase. Example: `dagRuns`.\n\nResource names are used as part of endpoint URLs, as well as in API parameters and responses.\n\n## CRUD Operations\n\nThe platform supports **C**reate, **R**ead, **U**pdate, and **D**elete operations on most resources.\nYou can review the standards for these operations and their standard parameters below.\n\nSome endpoints have special behavior as exceptions.\n\n### Create\n\nTo create a resource, you typically submit an HTTP `POST` request with the resource's required metadata\nin the request body.\nThe response returns a `201 Created` response code upon success with the resource's metadata, including\nits internal `id`, in the response body.\n\n### Read\n\nThe HTTP `GET` request can be used to read a resource or to list a number of resources.\n\nA resource's `id` can be submitted in the request parameters to read a specific resource.\nThe response usually returns a `200 OK` response code upon success, with the resource's metadata in\nthe response body.\n\nIf a `GET` request does not include a specific resource `id`, it is treated as a list request.\nThe response usually returns a `200 OK` response code upon success, with an object containing a list\nof resources' metadata in the response body.\n\nWhen reading resources, some common query parameters are usually available. e.g.:\n```\nv1/connections?limit=25&offset=25\n```\n\n|Query Parameter|Type|Description|\n|---------------|----|-----------|\n|limit|integer|Maximum number of objects to fetch. Usually 25 by default|\n|offset|integer|Offset after which to start returning objects. For use with limit query parameter.|\n\n### Update\n\nUpdating a resource requires the resource `id`, and is typically done using an HTTP `PATCH` request,\nwith the fields to modify in the request body.\nThe response usually returns a `200 OK` response code upon success, with information about the modified\nresource in the response body.\n\n### Delete\n\nDeleting a resource requires the resource `id` and is typically executing via an HTTP `DELETE` request.\nThe response usually returns a `204 No Content` response code upon success.\n\n## Conventions\n\n- Resource names are plural and expressed in camelCase.\n- Names are consistent between URL parameter name and field name.\n\n- Field names are in snake_case.\n```json\n{\n    \"name\": \"string\",\n    \"slots\": 0,\n    \"occupied_slots\": 0,\n    \"used_slots\": 0,\n    \"queued_slots\": 0,\n    \"open_slots\": 0\n}\n```\n\n### Update Mask\n\nUpdate mask is available as a query parameter in patch endpoints. It is used to notify the\nAPI which fields you want to update. Using `update_mask` makes it easier to update objects\nby helping the server know which fields to update in an object instead of updating all fields.\nThe update request ignores any fields that aren't specified in the field mask, leaving them with\ntheir current values.\n\nExample:\n```\n  resource = request.get('/resource/my-id').json()\n  resource['my_field'] = 'new-value'\n  request.patch('/resource/my-id?update_mask=my_field', data=json.dumps(resource))\n```\n\n## Versioning and Endpoint Lifecycle\n\n- API versioning is not synchronized to specific releases of the Apache Airflow.\n- APIs are designed to be backward compatible.\n- Any changes to the API will first go through a deprecation phase.\n\n# Trying the API\n\nYou can use a third party client, such as [curl](https://curl.haxx.se/), [HTTPie](https://httpie.org/),\n[Postman](https://www.postman.com/) or [the Insomnia rest client](https://insomnia.rest/) to test\nthe Apache Airflow API.\n\nNote that you will need to pass credentials data.\n\nFor e.g., here is how to pause a DAG with [curl](https://curl.haxx.se/), when basic authorization is used:\n```bash\ncurl -X PATCH 'https://example.com/api/v1/dags/{dag_id}?update_mask=is_paused' \\\n-H 'Content-Type: application/json' \\\n--user \"username:password\" \\\n-d '{\n    \"is_paused\": true\n}'\n```\n\nUsing a graphical tool such as [Postman](https://www.postman.com/) or [Insomnia](https://insomnia.rest/),\nit is possible to import the API specifications directly:\n\n1. Download the API specification by clicking the **Download** button at top of this document\n2. Import the JSON specification in the graphical tool of your choice.\n  - In *Postman*, you can click the **import** button at the top\n  - With *Insomnia*, you can just drag-and-drop the file on the UI\n\nNote that with *Postman*, you can also generate code snippets by selecting a request and clicking on\nthe **Code** button.\n\n## Enabling CORS\n\n[Cross-origin resource sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS)\nis a browser security feature that restricts HTTP requests that are\ninitiated from scripts running in the browser.\n\nFor details on enabling/configuring CORS, see\n[Enabling CORS](https://airflow.apache.org/docs/apache-airflow/stable/security/api.html).\n\n# Authentication\n\nTo be able to meet the requirements of many organizations, Airflow supports many authentication methods,\nand it is even possible to add your own method.\n\nIf you want to check which auth backend is currently set, you can use\n`airflow config get-value api auth_backends` command as in the example below.\n```bash\n$ airflow config get-value api auth_backends\nairflow.api.auth.backend.basic_auth\n```\nThe default is to deny all requests.\n\nFor details on configuring the authentication, see\n[API Authorization](https://airflow.apache.org/docs/apache-airflow/stable/security/api.html).\n\n# Errors\n\nWe follow the error response format proposed in [RFC 7807](https://tools.ietf.org/html/rfc7807)\nalso known as Problem Details for HTTP APIs. As with our normal API responses,\nyour client must be prepared to gracefully handle additional members of the response.\n\n## Unauthenticated\n\nThis indicates that the request has not been applied because it lacks valid authentication\ncredentials for the target resource. Please check that you have valid credentials.\n\n## PermissionDenied\n\nThis response means that the server understood the request but refuses to authorize\nit because it lacks sufficient rights to the resource. It happens when you do not have the\nnecessary permission to execute the action you performed. You need to get the appropriate\npermissions in other to resolve this error.\n\n## BadRequest\n\nThis response means that the server cannot or will not process the request due to something\nthat is perceived to be a client error (e.g., malformed request syntax, invalid request message\nframing, or deceptive request routing). To resolve this, please ensure that your syntax is correct.\n\n## NotFound\n\nThis client error response indicates that the server cannot find the requested resource.\n\n## MethodNotAllowed\n\nIndicates that the request method is known by the server but is not supported by the target resource.\n\n## NotAcceptable\n\nThe target resource does not have a current representation that would be acceptable to the user\nagent, according to the proactive negotiation header fields received in the request, and the\nserver is unwilling to supply a default representation.\n\n## AlreadyExists\n\nThe request could not be completed due to a conflict with the current state of the target\nresource, e.g. the resource it tries to create already exists.\n\n## Unknown\n\nThis means that the server encountered an unexpected condition that prevented it from\nfulfilling the request.\n"
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  title: Airflow API (Stable) Config DAG API
  version: '3.0'
  x-apisguru-categories:
  - messaging
  x-logo:
    url: https://twitter.com/TheASF/profile_image?size=original
  x-origin:
  - format: openapi
    url: https://airflow.apache.org/docs/apache-airflow/stable/_specs/v1.yaml
  x-providerName: apache.org
  x-serviceName: airflow
servers:
- description: Apache Airflow Stable API.
  url: /api/v1
- url: https://apache.local
security: []
tags:
- name: DAG
paths:
  /dagSources/{file_token}:
    parameters:
    - $ref: '#/components/parameters/FileToken'
    get:
      description: 'Get a source code using file token.

        '
      operationId: get_dag_source
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  content:
                    type: string
                type: object
            plain/text:
              schema:
                type: string
          description: Success.
        '401':
          $ref: '#/components/responses/Unauthenticated'
        '403':
          $ref: '#/components/responses/PermissionDenied'
        '404':
          $ref: '#/components/responses/NotFound'
        '406':
          $ref: '#/components/responses/NotAcceptable'
      summary: Apache Airflow Get a Source Code
      tags:
      - DAG
      x-openapi-router-controller: airflow.api_connexion.endpoints.dag_source_endpoint
  /dags:
    get:
      description: 'List DAGs in the database.

        `dag_id_pattern` can be set to match dags of a specific pattern

        '
      operationId: get_dags
      parameters:
      - $ref: '#/components/parameters/PageLimit'
      - $ref: '#/components/parameters/PageOffset'
      - $ref: '#/components/parameters/OrderBy'
      - $ref: '#/components/parameters/FilterTags'
      - $ref: '#/components/parameters/OnlyActive'
      - description: 'If set, only return DAGs with dag_ids matching this pattern.

          '
        in: query
        name: dag_id_pattern
        required: false
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DAGCollection'
          description: Success.
        '401':
          $ref: '#/components/responses/Unauthenticated'
      summary: Apache Airflow List DAGs
      tags:
      - DAG
      x-openapi-router-controller: airflow.api_connexion.endpoints.dag_endpoint
    patch:
      description: '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*

        '
      operationId: patch_dags
      parameters:
      - $ref: '#/components/parameters/PageLimit'
      - $ref: '#/components/parameters/PageOffset'
      - $ref: '#/components/parameters/FilterTags'
      - $ref: '#/components/parameters/UpdateMask'
      - $ref: '#/components/parameters/OnlyActive'
      - description: 'If set, only update DAGs with dag_ids matching this pattern.

          '
        in: query
        name: dag_id_pattern
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            example:
              is_paused: true
            schema:
              $ref: '#/components/schemas/DAG'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DAGCollection'
          description: Success.
        '401':
          $ref: '#/components/responses/Unauthenticated'
        '403':
          $ref: '#/components/responses/PermissionDenied'
        '404':
          $ref: '#/components/responses/NotFound'
      summary: Apache Airflow Update DAGs
      tags:
      - DAG
      x-openapi-router-controller: airflow.api_connexion.endpoints.dag_endpoint
  /dags/{dag_id}:
    parameters:
    - $ref: '#/components/parameters/DAGID'
    delete:
      description: '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*

        '
      operationId: delete_dag
      responses:
        '204':
          description: Success.
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthenticated'
        '403':
          $ref: '#/components/responses/PermissionDenied'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/AlreadyExists'
      summary: Apache Airflow Delete a DAG
      tags:
      - DAG
      x-openapi-router-controller: airflow.api_connexion.endpoints.dag_endpoint
    get:
      description: 'Presents only information available in database (DAGModel).

        If you need detailed information, consider using GET /dags/{dag_id}/details.

        '
      operationId: get_dag
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DAG'
          description: Success.
        '401':
          $ref: '#/components/responses/Unauthenticated'
        '403':
          $ref: '#/components/responses/PermissionDenied'
        '404':
          $ref: '#/components/responses/NotFound'
      summary: Apache Airflow Get Basic Information About a DAG
      tags:
      - DAG
      x-openapi-router-controller: airflow.api_connexion.endpoints.dag_endpoint
    patch:
      operationId: patch_dag
      parameters:
      - $ref: '#/components/parameters/UpdateMask'
      requestBody:
        content:
          application/json:
            example:
              is_paused: true
            schema:
              $ref: '#/components/schemas/DAG'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DAG'
          description: Success.
        '401':
          $ref: '#/components/responses/Unauthenticated'
        '403':
          $ref: '#/components/responses/PermissionDenied'
        '404':
          $ref: '#/components/responses/NotFound'
      summary: Apache Airflow Update a DAG
      tags:
      - DAG
      x-openapi-router-controller: airflow.api_connexion.endpoints.dag_endpoint
  /dags/{dag_id}/clearTaskInstances:
    parameters:
    - $ref: '#/components/parameters/DAGID'
    post:
      description: 'Clears a set of task instances associated with the DAG for a specified date range.

        '
      operationId: post_clear_task_instances
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClearTaskInstances'
        description: Parameters of action
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaskInstanceReferenceCollection'
          description: Success.
        '401':
          $ref: '#/components/responses/Unauthenticated'
        '403':
          $ref: '#/components/responses/PermissionDenied'
        '404':
          $ref: '#/components/responses/NotFound'
      summary: Apache Airflow Clear a Set of Task Instances
      tags:
      - DAG
      x-openapi-router-controller: airflow.api_connexion.endpoints.task_instance_endpoint
  /dags/{dag_id}/details:
    parameters:
    - $ref: '#/components/parameters/DAGID'
    get:
      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
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DAGDetail'
          description: Success.
        '401':
          $ref: '#/components/responses/Unauthenticated'
        '403':
          $ref: '#/components/responses/PermissionDenied'
        '404':
          $ref: '#/components/responses/NotFound'
      summary: Apache Airflow Get a Simplified Representation of DAG
      tags:
      - DAG
      x-openapi-router-controller: airflow.api_connexion.endpoints.dag_endpoint
  /dags/{dag_id}/tasks:
    parameters:
    - $ref: '#/components/parameters/DAGID'
    - $ref: '#/components/parameters/OrderBy'
    get:
      operationId: get_tasks
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaskCollection'
          description: Success.
        '401':
          $ref: '#/components/responses/Unauthenticated'
        '403':
          $ref: '#/components/responses/PermissionDenied'
        '404':
          $ref: '#/components/responses/NotFound'
      summary: Apache Airflow Get Tasks for DAG
      tags:
      - DAG
      x-openapi-router-controller: airflow.api_connexion.endpoints.task_endpoint
  /dags/{dag_id}/tasks/{task_id}:
    parameters:
    - $ref: '#/components/parameters/DAGID'
    - $ref: '#/components/parameters/TaskID'
    get:
      operationId: get_task
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Task'
          description: Success.
        '401':
          $ref: '#/components/responses/Unauthenticated'
        '403':
          $ref: '#/components/responses/PermissionDenied'
        '404':
          $ref: '#/components/responses/NotFound'
      summary: Apache Airflow Get Simplified Representation of a Task
      tags:
      - DAG
      x-openapi-router-controller: airflow.api_connexion.endpoints.task_endpoint
  /dags/{dag_id}/updateTaskInstancesState:
    parameters:
    - $ref: '#/components/parameters/DAGID'
    post:
      description: 'Updates the state for multiple task instances simultaneously.

        '
      operationId: post_set_task_instances_state
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateTaskInstancesState'
        description: Parameters of action
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaskInstanceReferenceCollection'
          description: Success.
        '401':
          $ref: '#/components/responses/Unauthenticated'
        '403':
          $ref: '#/components/responses/PermissionDenied'
        '404':
          $ref: '#/components/responses/NotFound'
      summary: Apache Airflow Set a State of Task Instances
      tags:
      - DAG
      x-openapi-router-controller: airflow.api_connexion.endpoints.task_instance_endpoint
components:
  schemas:
    Color:
      description: Color in hexadecimal notation.
      pattern: ^#[a-fA-F0-9]{3,6}$
      type: string
    UpdateTaskInstancesState:
      properties:
        dag_run_id:
          description: 'The task instance''s DAG run ID. Either set this or execution_date but not both.


            *New in version 2.3.0*

            '
          type: string
        dry_run:
          default: true
          description: 'If set, don''t actually run this operation. The response will contain a list of task instances

            planned to be affected, but won''t be modified in any way.

            '
          type: boolean
        execution_date:
          description: The execution date. Either set this or dag_run_id but not both.
          format: datetime
          type: string
        include_downstream:
          description: If set to true, downstream tasks are also affected.
          type: boolean
        include_future:
          description: If set to True, also tasks from future DAG Runs are affected.
          type: boolean
        include_past:
          description: If set to True, also tasks from past DAG Runs are affected.
          type: boolean
        include_upstream:
          description: If set to true, upstream tasks are also affected.
          type: boolean
        new_state:
          description: Expected new state.
          enum:
          - success
          - failed
          type: string
        task_id:
          description: The task ID.
          type: string
      type: object
    ClassReference:
      description: Class reference
      properties:
        class_name:
          readOnly: true
          type: string
        module_path:
          readOnly: true
          type: string
      type: object
    TaskInstanceReference:
      properties:
        dag_id:
          description: The DAG ID.
          readOnly: true
          type: string
        dag_run_id:
          description: The DAG run ID.
          readOnly: true
          type: string
        execution_date:
          format: datetime
          readOnly: true
          type: string
        task_id:
          description: The task ID.
          readOnly: true
          type: string
      type: object
    Tag:
      description: Tag
      properties:
        name:
          type: string
      type: object
    DAGDetail:
      allOf:
      - $ref: '#/components/schemas/DAG'
      - properties:
          catchup:
            readOnly: true
            type: boolean
          concurrency:
            readOnly: true
            type: number
          dag_run_timeout:
            $ref: '#/components/schemas/TimeDelta'
          default_view:
            readOnly: true
            type: string
          doc_md:
            readOnly: true
            type:
            - string
            - 'null'
          end_date:
            description: 'The DAG''s end date.


              *New in version 2.3.0*.

              '
            format: date-time
            readOnly: true
            type:
            - string
            - 'null'
          is_paused_upon_creation:
            description: 'Whether the DAG is paused upon creation.


              *New in version 2.3.0*

              '
            readOnly: true
            type:
            - boolean
            - 'null'
          last_parsed:
            description: 'The last time the DAG was parsed.


              *New in version 2.3.0*

              '
            format: date-time
            readOnly: true
            type:
            - string
            - 'null'
          orientation:
            readOnly: true
            type: string
          params:
            description: 'User-specified DAG params.


              *New in version 2.0.1*

              '
            readOnly: true
            type: object
          render_template_as_native_obj:
            description: 'Whether to render templates as native Python objects.


              *New in version 2.3.0*

              '
            readOnly: true
            type:
            - boolean
            - 'null'
          start_date:
            description: 'The DAG''s start date.


              *Changed in version 2.0.1*: Field becomes nullable.

              '
            format: date-time
            readOnly: true
            type:
            - string
            - 'null'
          template_search_path:
            description: 'The template search path.


              *New in version 2.3.0*

              '
            items:
              type: string
            type:
            - array
            - 'null'
          timezone:
            $ref: '#/components/schemas/Timezone'
        type: object
      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)

        '
    CollectionInfo:
      description: Metadata about collection.
      properties:
        total_entries:
          description: 'Count of total objects in the current result set before pagination parameters

            (limit, offset) are applied.

            '
          type: integer
      type: object
    TriggerRule:
      description: 'Trigger rule.


        *Changed in version 2.2.0*: ''none_failed_min_one_success'' is added as a possible value.

        '
      enum:
      - all_success
      - all_failed
      - all_done
      - one_success
      - one_failed
      - none_failed
      - none_skipped
      - none_failed_or_skipped
      - none_failed_min_one_success
      - dummy
      type: string
    Error:
      description: '[RFC7807](https://tools.ietf.org/html/rfc7807) compliant response.

        '
      properties:
        detail:
          description: A human-readable explanation specific to this occurrence of the problem.
          type: string
        instance:
          description: 'A URI reference that identifies the specific occurrence of the problem. It may or may

            not yield further information if dereferenced.

            '
          type: string
        status:
          description: The HTTP status code generated by the API server for this occurrence of the problem.
          type: number
        title:
          description: A short, human-readable summary of the problem type.
          type: string
        type:
          description: 'A URI reference [RFC3986] that identifies the problem type. This specification

            encourages that, when dereferenced, it provide human-readable documentation for

            the problem type.

            '
          type: string
      required:
      - type
      - title
      - status
      type: object
    TaskInstanceReferenceCollection:
      properties:
        task_instances:
          items:
            $ref: '#/components/schemas/TaskInstanceReference'
          type: array
      type: object
    TaskCollection:
      description: Collection of tasks.
      properties:
        tasks:
          items:
            $ref: '#/components/schemas/Task'
          type: array
      type: object
    Timezone:
      type: string
    DAG:
      description: DAG
      properties:
        dag_id:
          description: The ID of the DAG.
          readOnly: true
          type: string
        default_view:
          description: 'Default view of the DAG inside the webserver


            *New in version 2.3.0*

            '
          readOnly: true
          type:
          - string
          - 'null'
        description:
          description: 'User-provided DAG description, which can consist of several sentences or paragraphs that describe DAG contents.

            '
          readOnly: true
          type:
          - string
          - 'null'
        file_token:
          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.

            '
          readOnly: true
          type: string
        fileloc:
          description: The absolute path to the file.
          readOnly: true
          type: string
        has_import_errors:
          description: 'Whether the DAG has import errors


            *New in version 2.3.0*

            '
          readOnly: true
          type:
          - boolean
          - 'null'
        has_task_concurrency_limits:
          description: 'Whether the DAG has task concurrency limits


            *New in version 2.3.0*

            '
          readOnly: true
          type:
          - boolean
          - 'null'
        is_active:
          description: 'Whether the DAG is currently seen by the scheduler(s).


            *New in version 2.1.1*


            *Changed in version 2.2.0*: Field is read-only.

            '
          readOnly: true
          type:
          - boolean
          - 'null'
        is_paused:
          description: Whether the DAG is paused.
          type:
          - boolean
          - 'null'
        is_subdag:
          description: Whether the DAG is SubDAG.
          readOnly: true
          type: boolean
        last_expired:
          description: 'Time when the DAG last received a refresh signal

            (e.g. the DAG''s "refresh" button was clicked in the web UI)


            *New in version 2.3.0*

            '
          format: date-time
          readOnly: true
          type:
          - string
          - 'null'
        last_parsed_time:
          description: 'The last time the DAG was parsed.


            *New in version 2.3.0*

            '
          format: date-time
          readOnly: true
          type:
          - string
          - 'null'
        last_pickled:
          description: 'The last time the DAG was pickled.


            *New in version 2.3.0*

            '
          format: date-time
          readOnly: true
          type:
          - string
          - 'null'
        max_active_runs:
          description: 'Maximum number of active DAG runs for the DAG


            *New in version 2.3.0*

            '
          readOnly: true
          type:
          - integer
          - 'null'
        max_active_tasks:
          description: 'Maximum number of active tasks that can be run on the DAG


            *New in version 2.3.0*

            '
          readOnly: true
          type:
          - integer
          - 'null'
        next_dagrun:
          description: 'The logical date of the next dag run.


            *New in version 2.3.0*

            '
          format: date-time
          readOnly: true
          type:
          - string
          - 'null'
        next_dagrun_create_after:
          description: 'Earliest time at which this ``next_dagrun`` can be created.


            *New in version 2.3.0*

            '
          format: date-time
          readOnly: true
          type:
          - string
          - 'null'
        next_dagrun_data_interval_end:
          description: 'The end of the interval of the next dag run.


            *New in version 2.3.0*

            '
          format: date-time
          readOnly: true
          type:
          - string
          - 'null'
        next_dagrun_data_interval_start:
          description: 'The start of the interval of the next dag run.


            *New in version 2.3.0*

            '
          format: date-time
          readOnly: true
          type:
          - string
          - 'null'
        owners:
          items:
            type: string
          readOnly: true
          type: array
        pickle_id:
          description: 'Foreign key to the latest pickle_id


            *New in version 2.3.0*

            '
          readOnly: true
          type:
          - string
          - 'null'
        root_dag_id:
          description: If the DAG is SubDAG then it is the top level DAG identifier. Otherwise, null.
          readOnly: true
          type:
          - string
          - 'null'
        schedule_interval:
          $ref: '#/components/schemas/ScheduleInterval'
        scheduler_lock:
          description: 'Whether (one of) the scheduler is scheduling this DAG at the moment


            *New in version 2.3.0*

            '
          readOnly: true
          type:
          - boolean
          - 'null'
        tags:
          description: List of tags.
          items:
            $ref: '#/components/schemas/Tag'
          readOnly: true
          type:
          - array
          - 'null'
        timetable_description:
          description: 'Timetable/Schedule Interval description.


            *New in version 2.3.0*

            '
          readOnly: true
          type:
          - string
          - 'null'
      type: object
    DAGCollection:
      allOf:
      - properties:
          dags:
            items:
              $ref: '#/components/schemas/DAG'
            type: array
        type: object
      - $ref: '#/components/schemas/CollectionInfo'
      description: 'Collection of DAGs.


        *Changed in version 2.1.0*: ''total_entries'' field is added.

        '
      type: object
    WeightRule:
      description: Weight rule.
      enum:
      - downstream
      - upstream
      - absolute
   

# --- truncated at 32 KB (41 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/apache-airflow/refs/heads/main/openapi/apache-airflow-dag-api-openapi.yml