blob: eb731237c84cee24267c73ce9cda2f7de1eff331 [file] [log] [blame] [view]
# airflow_client.client.ProviderApi
All URIs are relative to */api/v1*
Method | HTTP request | Description
------------- | ------------- | -------------
[**get_providers**](ProviderApi.md#get_providers) | **GET** /providers | List providers
# **get_providers**
> bool, date, datetime, dict, float, int, list, str, none_type get_providers()
List providers
Get a list of providers. *New in version 2.1.0*
### Example
* Basic Authentication (Basic):
```python
import time
import airflow_client.client
from airflow_client.client.api import provider_api
from airflow_client.client.model.collection_info import CollectionInfo
from airflow_client.client.model.error import Error
from airflow_client.client.model.provider_collection import ProviderCollection
from pprint import pprint
# Defining the host is optional and defaults to /api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = airflow_client.client.Configuration(
host = "/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 = airflow_client.client.Configuration(
username = 'YOUR_USERNAME',
password = 'YOUR_PASSWORD'
)
# 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 = 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 airflow_client.client.ApiException as e:
print("Exception when calling ProviderApi->get_providers: %s\n" % e)
```
### Parameters
This endpoint does not need any parameter.
### Return type
**bool, date, datetime, dict, float, int, list, str, none_type**
### Authorization
[Basic](../README.md#Basic), [Kerberos](../README.md#Kerberos)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | List of providers. | - |
**401** | Request not authenticated due to missing, invalid, authentication info. | - |
**403** | Client does not have sufficient permission. | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)