Airflow API (Stable)

• API version: 1.0.0
  • Build date: 2021-05-28T08:16:16.047364Z[Etc/UTC]

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

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.

The platform supports Create, Read, Update, and Delete operations on most resources. You can review the standards for these operations and their standard parameters below.

Some endpoints have special behavior as exceptions.

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.

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

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.

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.

• Resource names are plural and expressed in camelCase.

• Names are consistent between URL parameter name and field name.

• Field names are in snake_case.

{
    \"name\": \"string\",
    \"slots\": 0,
    \"occupied_slots\": 0,
    \"used_slots\": 0,
    \"queued_slots\": 0,
    \"open_slots\": 0
}

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))

• 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.

You can use a third party client, such as curl, HTTPie, Postman or the Insomnia rest client 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, when basic authorization is used:

curl -X POST '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 or Insomnia, 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.

Cross-origin resource sharing (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.

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.

$ 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.

We follow the error response format proposed in RFC 7807 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.

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.

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.

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.

This client error response indicates that the server cannot find the requested resource.

Indicates that the request method is known by the server but is not supported by the target resource.

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.

The request could not be completed due to a conflict with the current state of the target resource, meaning that the resource already exists

This means that the server encountered an unexpected condition that prevented it from fulfilling the request.

For more information, please visit https://airflow.apache.org

Automatically generated by the OpenAPI Generator

Building the API client library requires:

1. Java 1.7+
2. Maven/Gradle

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Add this dependency to your project's POM:

<dependency>
  <groupId>org.openapitools</groupId>
  <artifactId>openapi-java-client</artifactId>
  <version>1.0.0</version>
  <scope>compile</scope>
</dependency>

Add this dependency to your project's build file:

compile "org.openapitools:openapi-java-client:1.0.0"

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

• target/openapi-java-client-1.0.0.jar
• target/lib/*.jar

Please follow the installation instruction and execute the following Java code:

// Import classes:
import org.openapitools.client.ApiClient;
import org.openapitools.client.ApiException;
import org.openapitools.client.Configuration;
import org.openapitools.client.models.*;
import org.openapitools.client.api.ConfigApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost/api/v1");

    ConfigApi apiInstance = new ConfigApi(defaultClient);
    try {
      Config result = apiInstance.getConfig();
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ConfigApi#getConfig");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

All URIs are relative to http://localhost/api/v1

• Action
• ActionCollection
• ActionCollectionAllOf
• ActionResource
• ClassReference
• ClearTaskInstance
• CollectionInfo
• Config
• ConfigOption
• ConfigSection
• Connection
• ConnectionAllOf
• ConnectionCollection
• ConnectionCollectionAllOf
• ConnectionCollectionItem
• ConnectionTest
• CronExpression
• DAG
• DAGCollection
• DAGCollectionAllOf
• DAGDetail
• DAGDetailAllOf
• DAGRun
• DAGRunCollection
• DAGRunCollectionAllOf
• DagState
• Error
• EventLog
• EventLogCollection
• EventLogCollectionAllOf
• ExtraLink
• ExtraLinkCollection
• HealthInfo
• HealthStatus
• ImportError
• ImportErrorCollection
• ImportErrorCollectionAllOf
• InlineResponse200
• InlineResponse2001
• ListDagRunsForm
• ListTaskInstanceForm
• MetadatabaseStatus
• PluginCollection
• PluginCollectionAllOf
• PluginCollectionItem
• Pool
• PoolCollection
• PoolCollectionAllOf
• Provider
• ProviderCollection
• RelativeDelta
• Resource
• Role
• RoleCollection
• RoleCollectionAllOf
• SLAMiss
• ScheduleInterval
• SchedulerStatus
• Tag
• Task
• TaskCollection
• TaskExtraLinks
• TaskInstance
• TaskInstanceCollection
• TaskInstanceCollectionAllOf
• TaskInstanceReference
• TaskInstanceReferenceCollection
• TaskState
• TimeDelta
• TriggerRule
• UpdateTaskInstancesState
• User
• UserAllOf
• UserCollection
• UserCollectionAllOf
• UserCollectionItem
• UserCollectionItemRoles
• Variable
• VariableAllOf
• VariableCollection
• VariableCollectionAllOf
• VariableCollectionItem
• VersionInfo
• WeightRule
• XCom
• XComAllOf
• XComCollection
• XComCollectionAllOf
• XComCollectionItem

Authentication schemes defined for the API:

• Type: HTTP basic authentication

• Type: HTTP basic authentication

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

[email protected]