Apache Airflow Python Client.ProviderApi

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

MethodHTTP requestDescription
get_providersGET /providersList providers

get_providers

object get_providers()

List providers

Example

  • Basic Authentication (Basic):
import time
import airflow_client.client
from airflow_client.client.api import provider_api
from airflow_client.client.model.error import Error
from pprint import pprint
# Defining the host is optional and defaults to http://localhost/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = client.Configuration(
    host = "http://localhost/api/v1"
)

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

# Configure HTTP basic authorization: Basic
configuration = client.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Enter a context with an instance of the API client
with client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = provider_api.ProviderApi(api_client)

    # example, this endpoint has no required or optional parameters
    try:
        # List providers
        api_response = api_instance.get_providers()
        pprint(api_response)
    except client.ApiException as e:
        print("Exception when calling ProviderApi->get_providers: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

object

Authorization

Basic, Kerberos

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status codeDescriptionResponse headers
200List of providers.-
401Request not authenticated due to missing, invalid, authentication info.-
403Client does not have sufficient permission.-

[Back to top] [Back to API list] [Back to Model list] [Back to README]