airflow_client.client.ConfigApi

All URIs are relative to http://localhost

Method	HTTP request	Description
get_config	GET /api/v2/config	Get Config
get_config_value	GET /api/v2/config/section/{section}/option/{option}	Get Config Value

get_config

Config get_config(section=section, accept=accept)

Get Config

Example

• OAuth Authentication (OAuth2PasswordBearer):
• Bearer Authentication (HTTPBearer):

import airflow_client.client
from airflow_client.client.models.config import Config
from airflow_client.client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = airflow_client.client.Configuration(
    host = "http://localhost"
)

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

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure Bearer authorization: HTTPBearer
configuration = airflow_client.client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with airflow_client.client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = airflow_client.client.ConfigApi(api_client)
    section = 'section_example' # str |  (optional)
    accept = */* # str |  (optional) (default to */*)

    try:
        # Get Config
        api_response = api_instance.get_config(section=section, accept=accept)
        print("The response of ConfigApi->get_config:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ConfigApi->get_config: %s\n" % e)

Parameters

Name	Type	Description	Notes
section	str		[optional]
accept	str		[optional] [default to /]

Return type

Config

Authorization

OAuth2PasswordBearer, HTTPBearer

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, text/plain

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
406	Not Acceptable	-
422	Validation Error	-

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

get_config_value

Config get_config_value(section, option, accept=accept)

Get Config Value

Example

• OAuth Authentication (OAuth2PasswordBearer):
• Bearer Authentication (HTTPBearer):

import airflow_client.client
from airflow_client.client.models.config import Config
from airflow_client.client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = airflow_client.client.Configuration(
    host = "http://localhost"
)

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

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure Bearer authorization: HTTPBearer
configuration = airflow_client.client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with airflow_client.client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = airflow_client.client.ConfigApi(api_client)
    section = 'section_example' # str | 
    option = 'option_example' # str | 
    accept = */* # str |  (optional) (default to */*)

    try:
        # Get Config Value
        api_response = api_instance.get_config_value(section, option, accept=accept)
        print("The response of ConfigApi->get_config_value:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ConfigApi->get_config_value: %s\n" % e)

Parameters

Name	Type	Description	Notes
section	str
option	str
accept	str		[optional] [default to /]

Return type

Config

Authorization

OAuth2PasswordBearer, HTTPBearer

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, text/plain

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
406	Not Acceptable	-
422	Validation Error	-

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