Skip to content

Latest commit

 

History

History
393 lines (264 loc) · 11.9 KB

OtherApi.md

File metadata and controls

393 lines (264 loc) · 11.9 KB

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 launchdarkly_api
from launchdarkly_api.models.caller_identity_rep import CallerIdentityRep
from launchdarkly_api.rest import ApiException
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'] = os.environ["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 = launchdarkly_api.OtherApi(api_client)

    try:
        # Identify the caller
        api_response = api_instance.get_caller_identity()
        print("The response of OtherApi->get_caller_identity:\n")
        pprint(api_response)
    except Exception 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 'Play' and enter any string in the 'Authorization' field to test this endpoint.

Example

  • Api Key Authentication (ApiKey):
import launchdarkly_api
from launchdarkly_api.models.ip_list import IpList
from launchdarkly_api.rest import ApiException
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'] = os.environ["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 = launchdarkly_api.OtherApi(api_client)

    try:
        # Gets the public IP list
        api_response = api_instance.get_ips()
        print("The response of OtherApi->get_ips:\n")
        pprint(api_response)
    except Exception 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 'Play' and enter any string in the 'Authorization' field to test this endpoint.

Example

  • Api Key Authentication (ApiKey):
import launchdarkly_api
from launchdarkly_api.rest import ApiException
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'] = os.environ["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 = launchdarkly_api.OtherApi(api_client)

    try:
        # Gets the OpenAPI spec in json
        api_instance.get_openapi_spec()
    except Exception 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 'Play' and enter any string in the 'Authorization' field to test this endpoint.

Example

  • Api Key Authentication (ApiKey):
import launchdarkly_api
from launchdarkly_api.models.root_response import RootResponse
from launchdarkly_api.rest import ApiException
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'] = os.environ["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 = launchdarkly_api.OtherApi(api_client)

    try:
        # Root resource
        api_response = api_instance.get_root()
        print("The response of OtherApi->get_root:\n")
        pprint(api_response)
    except Exception 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 launchdarkly_api
from launchdarkly_api.models.versions_rep import VersionsRep
from launchdarkly_api.rest import ApiException
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'] = os.environ["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 = launchdarkly_api.OtherApi(api_client)

    try:
        # Get version information
        api_response = api_instance.get_versions()
        print("The response of OtherApi->get_versions:\n")
        pprint(api_response)
    except Exception 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]