lilt.RootApi

All URIs are relative to https://lilt.com/2

Method	HTTP request	Description
root	GET /	Retrieve the REST API root

root

ApiRoot root()

Retrieve the REST API root

This resource does not have any attributes. It lists the name of the REST API. This endpoint can be used to verify REST API keys and to check the availability of the REST API.

Example

• Api Key Authentication (ApiKeyAuth): ```python from future import print_function import time import lilt from lilt.rest import ApiException from pprint import pprint

  Defining the host is optional and defaults to https://lilt.com/2

  See configuration.py for a list of all supported configuration parameters.

  configuration = lilt.Configuration( host = “https://lilt.com/2” )

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 API key authorization: ApiKeyAuth

configuration = lilt.Configuration( host = “https://lilt.com/2”, api_key = { ‘key’: ‘YOUR_API_KEY’ } )

Uncomment below to setup prefix (e.g. Bearer) for API key, if needed

configuration.api_key_prefix[‘key’] = ‘Bearer’

Configure HTTP basic authorization: BasicAuth

configuration = lilt.Configuration( username = ‘YOUR_USERNAME’, password = ‘YOUR_PASSWORD’ )

Enter a context with an instance of the API client

with lilt.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = lilt.RootApi(api_client)

try:
    # Retrieve the REST API root
    api_response = api_instance.root()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RootApi->root: %s\n" % e) ```

• Basic Authentication (BasicAuth): ```python from future import print_function import time import lilt from lilt.rest import ApiException from pprint import pprint

  Defining the host is optional and defaults to https://lilt.com/2

  See configuration.py for a list of all supported configuration parameters.

  configuration = lilt.Configuration( host = “https://lilt.com/2” )

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 API key authorization: ApiKeyAuth

configuration = lilt.Configuration( host = “https://lilt.com/2”, api_key = { ‘key’: ‘YOUR_API_KEY’ } )

Uncomment below to setup prefix (e.g. Bearer) for API key, if needed

configuration.api_key_prefix[‘key’] = ‘Bearer’

Configure HTTP basic authorization: BasicAuth

configuration = lilt.Configuration( username = ‘YOUR_USERNAME’, password = ‘YOUR_PASSWORD’ )

Enter a context with an instance of the API client

with lilt.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = lilt.RootApi(api_client)

try:
    # Retrieve the REST API root
    api_response = api_instance.root()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RootApi->root: %s\n" % e) ```

Parameters

This endpoint does not need any parameter.

Return type

ApiRoot

Authorization

ApiKeyAuth, BasicAuth

HTTP request headers

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

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| 200 | A status object. | - | 0 | Unexpected error | - |

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