blob: 0916f1d52422d76fb8aae7c10c2cd9aa410d0f78 [file] [log] [blame] [view]
# airflow_client.client.ProviderApi
All URIs are relative to *http://localhost*
Method | HTTP request | Description
------------- | ------------- | -------------
[**get_providers**](ProviderApi.md#get_providers) | **GET** /api/v2/providers | Get Providers
# **get_providers**
> ProviderCollectionResponse get_providers(limit=limit, offset=offset)
Get Providers
Get providers.
### Example
* OAuth Authentication (OAuth2PasswordBearer):
```python
import airflow_client.client
from airflow_client.client.models.provider_collection_response import ProviderCollectionResponse
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"]
# 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.ProviderApi(api_client)
limit = 50 # int | (optional) (default to 50)
offset = 0 # int | (optional) (default to 0)
try:
# Get Providers
api_response = api_instance.get_providers(limit=limit, offset=offset)
print("The response of ProviderApi->get_providers:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ProviderApi->get_providers: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**limit** | **int**| | [optional] [default to 50]
**offset** | **int**| | [optional] [default to 0]
### Return type
[**ProviderCollectionResponse**](ProviderCollectionResponse.md)
### Authorization
[OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response | - |
**401** | Unauthorized | - |
**403** | Forbidden | - |
**422** | Validation Error | - |
[[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)