Skip to content

Latest commit

 

History

History
93 lines (64 loc) · 3.08 KB

PluginApi.md

File metadata and controls

93 lines (64 loc) · 3.08 KB

titanium_airflow_client.PluginApi

All URIs are relative to /api/v1

Method HTTP request Description
get_plugins GET /plugins Get a list of loaded plugins

get_plugins

PluginCollection get_plugins(limit=limit, offset=offset)

Get a list of loaded plugins

Get a list of loaded plugins. New in version 2.1.0

Example

  • Basic Authentication (Basic):
import titanium_airflow_client
from titanium_airflow_client.models.plugin_collection import PluginCollection
from titanium_airflow_client.rest import ApiException
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 = titanium_airflow_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 = titanium_airflow_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with titanium_airflow_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = titanium_airflow_client.PluginApi(api_client)
    limit = 100 # int | The numbers of items to return. (optional) (default to 100)
    offset = 56 # int | The number of items to skip before starting to collect the result set. (optional)

    try:
        # Get a list of loaded plugins
        api_response = api_instance.get_plugins(limit=limit, offset=offset)
        print("The response of PluginApi->get_plugins:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PluginApi->get_plugins: %s\n" % e)

Parameters

Name Type Description Notes
limit int The numbers of items to return. [optional] [default to 100]
offset int The number of items to skip before starting to collect the result set. [optional]

Return type

PluginCollection

Authorization

Basic, Kerberos, GoogleOpenId

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Success -
401 Request not authenticated due to missing, invalid, authentication info. -
403 Client does not have sufficient permission. -
404 A specified resource is not found. -

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