launchdarkly_api.OtherApi

All URIs are relative to https://app.launchdarkly.com

Method	HTTP request	Description
get_caller_identity	GET /api/v2/caller-identity	Identify the caller
get_ips	GET /api/v2/public-ip-list	Gets the public IP list
get_openapi_spec	GET /api/v2/openapi.json	Gets the OpenAPI spec in json
get_root	GET /api/v2	Root resource
get_versions	GET /api/v2/versions	Get version information

get_caller_identity

CallerIdentityRep get_caller_identity()

Identify the caller

Get basic information about the identity used (session cookie, API token, SDK keys, etc.) to call the API

Example

Api Key Authentication (ApiKey):

import time
import launchdarkly_api
from launchdarkly_api.api import other_api
from launchdarkly_api.model.rate_limited_error_rep import RateLimitedErrorRep
from launchdarkly_api.model.caller_identity_rep import CallerIdentityRep
from launchdarkly_api.model.unauthorized_error_rep import UnauthorizedErrorRep
from pprint import pprint
# Defining the host is optional and defaults to https://app.launchdarkly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = launchdarkly_api.Configuration(
    host = "https://app.launchdarkly.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 API key authorization: ApiKey
configuration.api_key['ApiKey'] = 'YOUR_API_KEY'

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

# Enter a context with an instance of the API client
with launchdarkly_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = other_api.OtherApi(api_client)

    # example, this endpoint has no required or optional parameters
    try:
        # Identify the caller
        api_response = api_instance.get_caller_identity()
        pprint(api_response)
    except launchdarkly_api.ApiException as e:
        print("Exception when calling OtherApi->get_caller_identity: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

CallerIdentityRep

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Caller Identity	-
401	Invalid access token	-
429	Rate limited	-

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

get_ips

IpList get_ips()

Gets the public IP list

Get a list of IP ranges the LaunchDarkly service uses. You can use this list to allow LaunchDarkly through your firewall. We post upcoming changes to this list in advance on our status page.

In the sandbox, click 'Try it' and enter any string in the 'Authorization' field to test this endpoint.

Example

Api Key Authentication (ApiKey):

import time
import launchdarkly_api
from launchdarkly_api.api import other_api
from launchdarkly_api.model.rate_limited_error_rep import RateLimitedErrorRep
from launchdarkly_api.model.ip_list import IpList
from pprint import pprint
# Defining the host is optional and defaults to https://app.launchdarkly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = launchdarkly_api.Configuration(
    host = "https://app.launchdarkly.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 API key authorization: ApiKey
configuration.api_key['ApiKey'] = 'YOUR_API_KEY'

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

# Enter a context with an instance of the API client
with launchdarkly_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = other_api.OtherApi(api_client)

    # example, this endpoint has no required or optional parameters
    try:
        # Gets the public IP list
        api_response = api_instance.get_ips()
        pprint(api_response)
    except launchdarkly_api.ApiException as e:
        print("Exception when calling OtherApi->get_ips: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

IpList

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Public IP response	-
429	Rate limited	-

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

get_openapi_spec

get_openapi_spec()

Gets the OpenAPI spec in json

Get the latest version of the OpenAPI specification for LaunchDarkly's API in JSON format. In the sandbox, click 'Try it' and enter any string in the 'Authorization' field to test this endpoint.

Example

Api Key Authentication (ApiKey):

import time
import launchdarkly_api
from launchdarkly_api.api import other_api
from launchdarkly_api.model.rate_limited_error_rep import RateLimitedErrorRep
from pprint import pprint
# Defining the host is optional and defaults to https://app.launchdarkly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = launchdarkly_api.Configuration(
    host = "https://app.launchdarkly.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 API key authorization: ApiKey
configuration.api_key['ApiKey'] = 'YOUR_API_KEY'

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

# Enter a context with an instance of the API client
with launchdarkly_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = other_api.OtherApi(api_client)

    # example, this endpoint has no required or optional parameters
    try:
        # Gets the OpenAPI spec in json
        api_instance.get_openapi_spec()
    except launchdarkly_api.ApiException as e:
        print("Exception when calling OtherApi->get_openapi_spec: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OpenAPI Spec	-
429	Rate limited	-

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

get_root

RootResponse get_root()

Root resource

Get all of the resource categories the API supports. In the sandbox, click 'Try it' and enter any string in the 'Authorization' field to test this endpoint.

Example

Api Key Authentication (ApiKey):

import time
import launchdarkly_api
from launchdarkly_api.api import other_api
from launchdarkly_api.model.rate_limited_error_rep import RateLimitedErrorRep
from launchdarkly_api.model.root_response import RootResponse
from pprint import pprint
# Defining the host is optional and defaults to https://app.launchdarkly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = launchdarkly_api.Configuration(
    host = "https://app.launchdarkly.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 API key authorization: ApiKey
configuration.api_key['ApiKey'] = 'YOUR_API_KEY'

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

# Enter a context with an instance of the API client
with launchdarkly_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = other_api.OtherApi(api_client)

    # example, this endpoint has no required or optional parameters
    try:
        # Root resource
        api_response = api_instance.get_root()
        pprint(api_response)
    except launchdarkly_api.ApiException as e:
        print("Exception when calling OtherApi->get_root: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

RootResponse

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Root response	-
429	Rate limited	-

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

get_versions

VersionsRep get_versions()

Get version information

Get the latest API version, the list of valid API versions in ascending order, and the version being used for this request. These are all in the external, date-based format.

Example

Api Key Authentication (ApiKey):

import time
import launchdarkly_api
from launchdarkly_api.api import other_api
from launchdarkly_api.model.forbidden_error_rep import ForbiddenErrorRep
from launchdarkly_api.model.versions_rep import VersionsRep
from launchdarkly_api.model.rate_limited_error_rep import RateLimitedErrorRep
from launchdarkly_api.model.unauthorized_error_rep import UnauthorizedErrorRep
from pprint import pprint
# Defining the host is optional and defaults to https://app.launchdarkly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = launchdarkly_api.Configuration(
    host = "https://app.launchdarkly.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 API key authorization: ApiKey
configuration.api_key['ApiKey'] = 'YOUR_API_KEY'

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

# Enter a context with an instance of the API client
with launchdarkly_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = other_api.OtherApi(api_client)

    # example, this endpoint has no required or optional parameters
    try:
        # Get version information
        api_response = api_instance.get_versions()
        pprint(api_response)
    except launchdarkly_api.ApiException as e:
        print("Exception when calling OtherApi->get_versions: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

VersionsRep

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Versions information response	-
401	Invalid access token	-
403	Forbidden	-
429	Rate limited	-

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

Files

OtherApi.md

Latest commit

History

OtherApi.md

File metadata and controls

launchdarkly_api.OtherApi

get_caller_identity

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_ips

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_openapi_spec

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_root

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_versions

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details