Airflow API (Stable)
# 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| |--
Description supplied by the publisher; it is a claim, not verified evidence.
- Name
- apisguru:apache.org
- Listed in
- APIs.guru
- Publisher
- apache.org
- Latest version
- 2.5.1
- Published
- 2023-03-04
- Evidence
- Listed only, not analyzed yet
What a full analysis of Airflow API (Stable) checks
Not checked yet. About 60 tools are analyzed every hour; each check links to its source when it runs:
- Publisher identity: not checked yet
- Repository ownership: not checked yet
- Organization verification: not checked yet
- Artifact provenance: not checked yet
- Source availability: not checked yet
- Version evidence: not checked yet
- Known vulnerabilities: not checked yet
- Install scripts: not checked yet
- Maintenance: not checked yet
- License: not checked yet
Before you install it
- Open the repository and confirm the account is the one you expect: look-alike names are common.
- Read what it asks for: files, accounts, network access and credentials it needs.
- Prefer a version from a verified publisher when one exists.