launchdarkly_api.ApplicationsBetaApi

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

Method	HTTP request	Description
delete_application	DELETE /api/v2/applications/{applicationKey}	Delete application
delete_application_version	DELETE /api/v2/applications/{applicationKey}/versions/{versionKey}	Delete application version
get_application	GET /api/v2/applications/{applicationKey}	Get application by key
get_application_versions	GET /api/v2/applications/{applicationKey}/versions	Get application versions by application key
get_applications	GET /api/v2/applications	Get applications
patch_application	PATCH /api/v2/applications/{applicationKey}	Update application
patch_application_version	PATCH /api/v2/applications/{applicationKey}/versions/{versionKey}	Update application version

delete_application

delete_application(application_key)

Delete application

Delete an application.

Example

Api Key Authentication (ApiKey):

import time
import launchdarkly_api
from launchdarkly_api.api import applications_beta_api
from launchdarkly_api.model.forbidden_error_rep import ForbiddenErrorRep
from launchdarkly_api.model.not_found_error_rep import NotFoundErrorRep
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 = applications_beta_api.ApplicationsBetaApi(api_client)
    application_key = "applicationKey_example" # str | The application key

    # example passing only required values which don't have defaults set
    try:
        # Delete application
        api_instance.delete_application(application_key)
    except launchdarkly_api.ApiException as e:
        print("Exception when calling ApplicationsBetaApi->delete_application: %s\n" % e)

Parameters

Name	Type	Description	Notes
application_key	str	The application key

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
204	Action succeeded	-
401	Invalid access token	-
403	Forbidden	-
404	Invalid resource identifier	-
429	Rate limited	-

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

delete_application_version

delete_application_version(application_key, version_key)

Delete application version

Delete an application version.

Example

Api Key Authentication (ApiKey):

import time
import launchdarkly_api
from launchdarkly_api.api import applications_beta_api
from launchdarkly_api.model.forbidden_error_rep import ForbiddenErrorRep
from launchdarkly_api.model.not_found_error_rep import NotFoundErrorRep
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 = applications_beta_api.ApplicationsBetaApi(api_client)
    application_key = "applicationKey_example" # str | The application key
    version_key = "versionKey_example" # str | The application version key

    # example passing only required values which don't have defaults set
    try:
        # Delete application version
        api_instance.delete_application_version(application_key, version_key)
    except launchdarkly_api.ApiException as e:
        print("Exception when calling ApplicationsBetaApi->delete_application_version: %s\n" % e)

Parameters

Name	Type	Description	Notes
application_key	str	The application key
version_key	str	The application version key

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
204	Action succeeded	-
401	Invalid access token	-
403	Forbidden	-
404	Invalid resource identifier	-
429	Rate limited	-

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

get_application

ApplicationRep get_application(application_key)

Get application by key

Retrieve an application by the application key. ### Expanding the application response LaunchDarkly supports expanding the "Get application" response to include additional fields. To expand the response, append the expand query parameter and include the following: * flags includes details on the flags that have been evaluated by the application For example, use ?expand=flags to include the flags field in the response. By default, this field is not included in the response.

Example

Api Key Authentication (ApiKey):

import time
import launchdarkly_api
from launchdarkly_api.api import applications_beta_api
from launchdarkly_api.model.invalid_request_error_rep import InvalidRequestErrorRep
from launchdarkly_api.model.forbidden_error_rep import ForbiddenErrorRep
from launchdarkly_api.model.not_found_error_rep import NotFoundErrorRep
from launchdarkly_api.model.rate_limited_error_rep import RateLimitedErrorRep
from launchdarkly_api.model.unauthorized_error_rep import UnauthorizedErrorRep
from launchdarkly_api.model.application_rep import ApplicationRep
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 = applications_beta_api.ApplicationsBetaApi(api_client)
    application_key = "applicationKey_example" # str | The application key
    expand = "expand_example" # str | A comma-separated list of properties that can reveal additional information in the response. Options: `flags`. (optional)

    # example passing only required values which don't have defaults set
    try:
        # Get application by key
        api_response = api_instance.get_application(application_key)
        pprint(api_response)
    except launchdarkly_api.ApiException as e:
        print("Exception when calling ApplicationsBetaApi->get_application: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get application by key
        api_response = api_instance.get_application(application_key, expand=expand)
        pprint(api_response)
    except launchdarkly_api.ApiException as e:
        print("Exception when calling ApplicationsBetaApi->get_application: %s\n" % e)

Parameters

Name	Type	Description	Notes
application_key	str	The application key
expand	str	A comma-separated list of properties that can reveal additional information in the response. Options: `flags`.	[optional]

Return type

ApplicationRep

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Application response	-
400	Invalid request	-
401	Invalid access token	-
403	Forbidden	-
404	Invalid resource identifier	-
429	Rate limited	-

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

get_application_versions

ApplicationVersionsCollectionRep get_application_versions(application_key)

Get application versions by application key

Get a list of versions for a specific application in an account.

Example

Api Key Authentication (ApiKey):

import time
import launchdarkly_api
from launchdarkly_api.api import applications_beta_api
from launchdarkly_api.model.application_versions_collection_rep import ApplicationVersionsCollectionRep
from launchdarkly_api.model.invalid_request_error_rep import InvalidRequestErrorRep
from launchdarkly_api.model.forbidden_error_rep import ForbiddenErrorRep
from launchdarkly_api.model.not_found_error_rep import NotFoundErrorRep
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 = applications_beta_api.ApplicationsBetaApi(api_client)
    application_key = "applicationKey_example" # str | The application key
    filter = "filter_example" # str | Accepts filter by `key`, `name`, `supported`, and `autoAdded`. To learn more about the filter syntax, read [Filtering applications and application versions](/tag/Applications-(beta)#filtering-contexts-and-context-instances). (optional)
    limit = 1 # int | The number of versions to return. Defaults to 50. (optional)
    offset = 1 # int | Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. (optional)
    sort = "sort_example" # str | Accepts sorting order and fields. Fields can be comma separated. Possible fields are `creationDate`, `name`. Examples: `sort=name` sort by names ascending, `sort=-name,creationDate` sort by names descending and creationDate ascending. (optional)

    # example passing only required values which don't have defaults set
    try:
        # Get application versions by application key
        api_response = api_instance.get_application_versions(application_key)
        pprint(api_response)
    except launchdarkly_api.ApiException as e:
        print("Exception when calling ApplicationsBetaApi->get_application_versions: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get application versions by application key
        api_response = api_instance.get_application_versions(application_key, filter=filter, limit=limit, offset=offset, sort=sort)
        pprint(api_response)
    except launchdarkly_api.ApiException as e:
        print("Exception when calling ApplicationsBetaApi->get_application_versions: %s\n" % e)

Parameters

Name	Type	Description	Notes
application_key	str	The application key
filter	str	Accepts filter by `key`, `name`, `supported`, and `autoAdded`. To learn more about the filter syntax, read Filtering applications and application versions.	[optional]
limit	int	The number of versions to return. Defaults to 50.	[optional]
offset	int	Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`.	[optional]
sort	str	Accepts sorting order and fields. Fields can be comma separated. Possible fields are `creationDate`, `name`. Examples: `sort=name` sort by names ascending, `sort=-name,creationDate` sort by names descending and creationDate ascending.	[optional]

Return type

ApplicationVersionsCollectionRep

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Application versions response	-
400	Invalid request	-
401	Invalid access token	-
403	Forbidden	-
404	Invalid resource identifier	-
429	Rate limited	-

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

get_applications

ApplicationCollectionRep get_applications()

Get applications

Get a list of applications. ### Expanding the applications response LaunchDarkly supports expanding the "Get applications" response to include additional fields. To expand the response, append the expand query parameter and include the following: * flags includes details on the flags that have been evaluated by the application For example, use ?expand=flags to include the flags field in the response. By default, this field is not included in the response.

Example

Api Key Authentication (ApiKey):

import time
import launchdarkly_api
from launchdarkly_api.api import applications_beta_api
from launchdarkly_api.model.invalid_request_error_rep import InvalidRequestErrorRep
from launchdarkly_api.model.forbidden_error_rep import ForbiddenErrorRep
from launchdarkly_api.model.not_found_error_rep import NotFoundErrorRep
from launchdarkly_api.model.rate_limited_error_rep import RateLimitedErrorRep
from launchdarkly_api.model.application_collection_rep import ApplicationCollectionRep
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 = applications_beta_api.ApplicationsBetaApi(api_client)
    filter = "filter_example" # str | Accepts filter by `key`, `name`, `kind`, and `autoAdded`. To learn more about the filter syntax, read [Filtering applications and application versions](/tag/Applications-(beta)#filtering-contexts-and-context-instances). (optional)
    limit = 1 # int | The number of applications to return. Defaults to 10. (optional)
    offset = 1 # int | Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. (optional)
    sort = "sort_example" # str | Accepts sorting order and fields. Fields can be comma separated. Possible fields are `creationDate`, `name`. Examples: `sort=name` sort by names ascending, `sort=-name,creationDate` sort by names descending and creationDate ascending. (optional)
    expand = "expand_example" # str | A comma-separated list of properties that can reveal additional information in the response. Options: `flags`. (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get applications
        api_response = api_instance.get_applications(filter=filter, limit=limit, offset=offset, sort=sort, expand=expand)
        pprint(api_response)
    except launchdarkly_api.ApiException as e:
        print("Exception when calling ApplicationsBetaApi->get_applications: %s\n" % e)

Parameters

Name	Type	Description	Notes
filter	str	Accepts filter by `key`, `name`, `kind`, and `autoAdded`. To learn more about the filter syntax, read Filtering applications and application versions.	[optional]
limit	int	The number of applications to return. Defaults to 10.	[optional]
offset	int	Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`.	[optional]
sort	str	Accepts sorting order and fields. Fields can be comma separated. Possible fields are `creationDate`, `name`. Examples: `sort=name` sort by names ascending, `sort=-name,creationDate` sort by names descending and creationDate ascending.	[optional]
expand	str	A comma-separated list of properties that can reveal additional information in the response. Options: `flags`.	[optional]

Return type

ApplicationCollectionRep

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Applications response	-
400	Invalid request	-
401	Invalid access token	-
403	Forbidden	-
404	Invalid resource identifier	-
429	Rate limited	-

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

patch_application

ApplicationRep patch_application(application_key, json_patch)

Update application

Update an application. You can update the description and kind fields. Requires a JSON patch representation of the desired changes to the application. To learn more, read Updates.

Example

Api Key Authentication (ApiKey):

import time
import launchdarkly_api
from launchdarkly_api.api import applications_beta_api
from launchdarkly_api.model.json_patch import JSONPatch
from launchdarkly_api.model.invalid_request_error_rep import InvalidRequestErrorRep
from launchdarkly_api.model.forbidden_error_rep import ForbiddenErrorRep
from launchdarkly_api.model.not_found_error_rep import NotFoundErrorRep
from launchdarkly_api.model.rate_limited_error_rep import RateLimitedErrorRep
from launchdarkly_api.model.unauthorized_error_rep import UnauthorizedErrorRep
from launchdarkly_api.model.application_rep import ApplicationRep
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 = applications_beta_api.ApplicationsBetaApi(api_client)
    application_key = "applicationKey_example" # str | The application key
    json_patch = JSONPatch([
        PatchOperation(
            op="replace",
            path="/exampleField",
            value=None,
        ),
    ]) # JSONPatch | 

    # example passing only required values which don't have defaults set
    try:
        # Update application
        api_response = api_instance.patch_application(application_key, json_patch)
        pprint(api_response)
    except launchdarkly_api.ApiException as e:
        print("Exception when calling ApplicationsBetaApi->patch_application: %s\n" % e)

Parameters

Name	Type	Description	Notes
application_key	str	The application key
json_patch	JSONPatch

Return type

ApplicationRep

Authorization

ApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Application response	-
400	Invalid request	-
401	Invalid access token	-
403	Forbidden	-
404	Invalid resource identifier	-
429	Rate limited	-

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

patch_application_version

ApplicationVersionRep patch_application_version(application_key, version_key, json_patch)

Update application version

Update an application version. You can update the supported field. Requires a JSON patch representation of the desired changes to the application version. To learn more, read Updates.

Example

Api Key Authentication (ApiKey):

import time
import launchdarkly_api
from launchdarkly_api.api import applications_beta_api
from launchdarkly_api.model.application_version_rep import ApplicationVersionRep
from launchdarkly_api.model.json_patch import JSONPatch
from launchdarkly_api.model.invalid_request_error_rep import InvalidRequestErrorRep
from launchdarkly_api.model.forbidden_error_rep import ForbiddenErrorRep
from launchdarkly_api.model.not_found_error_rep import NotFoundErrorRep
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 = applications_beta_api.ApplicationsBetaApi(api_client)
    application_key = "applicationKey_example" # str | The application key
    version_key = "versionKey_example" # str | The application version key
    json_patch = JSONPatch([
        PatchOperation(
            op="replace",
            path="/exampleField",
            value=None,
        ),
    ]) # JSONPatch | 

    # example passing only required values which don't have defaults set
    try:
        # Update application version
        api_response = api_instance.patch_application_version(application_key, version_key, json_patch)
        pprint(api_response)
    except launchdarkly_api.ApiException as e:
        print("Exception when calling ApplicationsBetaApi->patch_application_version: %s\n" % e)

Parameters

Name	Type	Description
application_key	str	The application key
version_key	str	The application version key
json_patch	JSONPatch

Return type

ApplicationVersionRep

Authorization

ApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Application version response	-
400	Invalid request	-
401	Invalid access token	-
403	Forbidden	-
404	Invalid resource identifier	-
429	Rate limited	-

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

Files

ApplicationsBetaApi.md

Latest commit

History

ApplicationsBetaApi.md

File metadata and controls

launchdarkly_api.ApplicationsBetaApi

delete_application

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_application_version

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_application

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_application_versions

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_applications

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

patch_application

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

patch_application_version

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details