Skip to content

DomainsApi.md

Latest commit

 

History

History
102 lines (69 loc) · 3.13 KB

DomainsApi.md

File metadata and controls

102 lines (69 loc) · 3.13 KB

lilt.DomainsApi

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

Method HTTP request Description
get_domains GET /v3/domains Retrieve Domains

get_domains

DomainList get_domains(key)

Retrieve Domains

Retrieve a list of Domains associated with the Organization's API key.

Each Domain contains potentially 4 Arrays related to the Domain these are as follows:

  • models - the list of models associated with the Domain
  • filterConfigs - the list of filterConfigs associated with the Domain
  • domainMetadata - the list of Domain specific options that have been configured for this domain.

Example

  • Basic Authentication (BasicAuth):
  • Api Key Authentication (ApiKeyAuth):
import lilt
from lilt.models.domain_list import DomainList
from lilt.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.lilt.com
# See configuration.py for a list of all supported configuration parameters.
configuration = lilt.Configuration(
    host = "https://api.lilt.com"
)

# 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: BasicAuth
configuration = lilt.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# 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.DomainsApi(api_client)
    key = 'key_example' # str | the ApiKey used to authenticate with LILT, used to look up the Organization's domain information.

    try:
        # Retrieve Domains
        api_response = api_instance.get_domains(key)
        print("The response of DomainsApi->get_domains:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DomainsApi->get_domains: %s\n" % e)

Parameters

Name Type Description Notes
key str the ApiKey used to authenticate with LILT, used to look up the Organization's domain information.

Return type

DomainList

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -
404 Not Found -

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