launchdarkly_api.PersistentStoreIntegrationsBetaApi

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

Method	HTTP request	Description
create_big_segment_store_integration	POST /api/v2/integration-capabilities/big-segment-store/{projectKey}/{environmentKey}/{integrationKey}	Create big segment store integration
delete_big_segment_store_integration	DELETE /api/v2/integration-capabilities/big-segment-store/{projectKey}/{environmentKey}/{integrationKey}/{integrationId}	Delete big segment store integration
get_big_segment_store_integration	GET /api/v2/integration-capabilities/big-segment-store/{projectKey}/{environmentKey}/{integrationKey}/{integrationId}	Get big segment store integration by ID
get_big_segment_store_integrations	GET /api/v2/integration-capabilities/big-segment-store	List all big segment store integrations
patch_big_segment_store_integration	PATCH /api/v2/integration-capabilities/big-segment-store/{projectKey}/{environmentKey}/{integrationKey}/{integrationId}	Update big segment store integration

create_big_segment_store_integration

BigSegmentStoreIntegration create_big_segment_store_integration(project_key, environment_key, integration_key, integration_delivery_configuration_post)

Create big segment store integration

Create a persistent store integration. If you are using server-side SDKs, segments synced from external tools and larger list-based segments require a persistent store within your infrastructure. LaunchDarkly keeps the persistent store up to date and consults it during flag evaluation. You can use either Redis or DynamoDB as your persistent store. When you create a persistent store integration, the fields in the config object in the request vary depending on which persistent store you use. If you are using Redis to create your persistent store integration, you will need to know: * Your Redis host * Your Redis port * Your Redis username * Your Redis password * Whether or not LaunchDarkly should connect using TLS If you are using DynamoDB to create your persistent store integration, you will need to know: * Your DynamoDB table name. The table must have the following schema: * Partition key: namespace (string) * Sort key: key (string) * Your DynamoDB Amazon Web Services (AWS) region. * Your AWS role Amazon Resource Name (ARN). This is the role that LaunchDarkly will assume to manage your DynamoDB table. * The External ID you specified when creating your Amazon Resource Name (ARN). To learn more, read Segment configuration.

Example

Api Key Authentication (ApiKey):

import time
import launchdarkly_api
from launchdarkly_api.api import persistent_store_integrations_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.integration_delivery_configuration_post import IntegrationDeliveryConfigurationPost
from launchdarkly_api.model.not_found_error_rep import NotFoundErrorRep
from launchdarkly_api.model.rate_limited_error_rep import RateLimitedErrorRep
from launchdarkly_api.model.big_segment_store_integration import BigSegmentStoreIntegration
from launchdarkly_api.model.unauthorized_error_rep import UnauthorizedErrorRep
from launchdarkly_api.model.status_conflict_error_rep import StatusConflictErrorRep
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 = persistent_store_integrations_beta_api.PersistentStoreIntegrationsBetaApi(api_client)
    project_key = "projectKey_example" # str | The project key
    environment_key = "environmentKey_example" # str | The environment key
    integration_key = "integrationKey_example" # str | The integration key, either `redis` or `dynamodb`
    integration_delivery_configuration_post = IntegrationDeliveryConfigurationPost(
        on=False,
        config=FormVariableConfig(
            key=None,
        ),
        tags=["example-tag"],
        name="Sample integration",
    ) # IntegrationDeliveryConfigurationPost | 

    # example passing only required values which don't have defaults set
    try:
        # Create big segment store integration
        api_response = api_instance.create_big_segment_store_integration(project_key, environment_key, integration_key, integration_delivery_configuration_post)
        pprint(api_response)
    except launchdarkly_api.ApiException as e:
        print("Exception when calling PersistentStoreIntegrationsBetaApi->create_big_segment_store_integration: %s\n" % e)

Parameters

Name	Type	Description
project_key	str	The project key
environment_key	str	The environment key
integration_key	str	The integration key, either `redis` or `dynamodb`
integration_delivery_configuration_post	IntegrationDeliveryConfigurationPost

Return type

BigSegmentStoreIntegration

Authorization

ApiKey

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	Big segment store response	-
400	Invalid request	-
401	Invalid access token	-
403	Forbidden	-
404	Environment or project not found	-
409	Status conflict	-
429	Rate limited	-

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

delete_big_segment_store_integration

delete_big_segment_store_integration(project_key, environment_key, integration_key, integration_id)

Delete big segment store integration

Delete a persistent store integration. Each integration uses either Redis or DynamoDB.

Example

Api Key Authentication (ApiKey):

import time
import launchdarkly_api
from launchdarkly_api.api import persistent_store_integrations_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 launchdarkly_api.model.status_conflict_error_rep import StatusConflictErrorRep
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 = persistent_store_integrations_beta_api.PersistentStoreIntegrationsBetaApi(api_client)
    project_key = "projectKey_example" # str | The project key
    environment_key = "environmentKey_example" # str | The environment key
    integration_key = "integrationKey_example" # str | The integration key, either `redis` or `dynamodb`
    integration_id = "integrationId_example" # str | The integration ID

    # example passing only required values which don't have defaults set
    try:
        # Delete big segment store integration
        api_instance.delete_big_segment_store_integration(project_key, environment_key, integration_key, integration_id)
    except launchdarkly_api.ApiException as e:
        print("Exception when calling PersistentStoreIntegrationsBetaApi->delete_big_segment_store_integration: %s\n" % e)

Parameters

Name	Type	Description
project_key	str	The project key
environment_key	str	The environment key
integration_key	str	The integration key, either `redis` or `dynamodb`
integration_id	str	The integration ID

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 completed successfully	-
401	Invalid access token	-
403	Forbidden	-
404	Environment or project not found	-
409	Status conflict	-
429	Rate limited	-

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

get_big_segment_store_integration

BigSegmentStoreIntegration get_big_segment_store_integration(project_key, environment_key, integration_key, integration_id)

Get big segment store integration by ID

Get a big segment store integration by ID.

Example

Api Key Authentication (ApiKey):

import time
import launchdarkly_api
from launchdarkly_api.api import persistent_store_integrations_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.big_segment_store_integration import BigSegmentStoreIntegration
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 = persistent_store_integrations_beta_api.PersistentStoreIntegrationsBetaApi(api_client)
    project_key = "projectKey_example" # str | The project key
    environment_key = "environmentKey_example" # str | The environment key
    integration_key = "integrationKey_example" # str | The integration key, either `redis` or `dynamodb`
    integration_id = "integrationId_example" # str | The integration ID

    # example passing only required values which don't have defaults set
    try:
        # Get big segment store integration by ID
        api_response = api_instance.get_big_segment_store_integration(project_key, environment_key, integration_key, integration_id)
        pprint(api_response)
    except launchdarkly_api.ApiException as e:
        print("Exception when calling PersistentStoreIntegrationsBetaApi->get_big_segment_store_integration: %s\n" % e)

Parameters

Name	Type	Description
project_key	str	The project key
environment_key	str	The environment key
integration_key	str	The integration key, either `redis` or `dynamodb`
integration_id	str	The integration ID

Return type

BigSegmentStoreIntegration

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Big segment store response	-
401	Invalid access token	-
403	Forbidden	-
404	Environment or project not found	-
429	Rate limited	-

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

get_big_segment_store_integrations

BigSegmentStoreIntegrationCollection get_big_segment_store_integrations()

List all big segment store integrations

List all big segment store integrations.

Example

Api Key Authentication (ApiKey):

import time
import launchdarkly_api
from launchdarkly_api.api import persistent_store_integrations_beta_api
from launchdarkly_api.model.forbidden_error_rep import ForbiddenErrorRep
from launchdarkly_api.model.big_segment_store_integration_collection import BigSegmentStoreIntegrationCollection
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 = persistent_store_integrations_beta_api.PersistentStoreIntegrationsBetaApi(api_client)

    # example, this endpoint has no required or optional parameters
    try:
        # List all big segment store integrations
        api_response = api_instance.get_big_segment_store_integrations()
        pprint(api_response)
    except launchdarkly_api.ApiException as e:
        print("Exception when calling PersistentStoreIntegrationsBetaApi->get_big_segment_store_integrations: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

BigSegmentStoreIntegrationCollection

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Big segment store collection response	-
401	Invalid access token	-
403	Forbidden	-
404	Environment or project not found	-
429	Rate limited	-

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

patch_big_segment_store_integration

BigSegmentStoreIntegration patch_big_segment_store_integration(project_key, environment_key, integration_key, integration_id, json_patch)

Update big segment store integration

Update a big segment store integration. Updating a big segment store requires a JSON Patch representation of the desired changes. To learn more, read Updates.

Example

Api Key Authentication (ApiKey):

import time
import launchdarkly_api
from launchdarkly_api.api import persistent_store_integrations_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.big_segment_store_integration import BigSegmentStoreIntegration
from launchdarkly_api.model.unauthorized_error_rep import UnauthorizedErrorRep
from launchdarkly_api.model.status_conflict_error_rep import StatusConflictErrorRep
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 = persistent_store_integrations_beta_api.PersistentStoreIntegrationsBetaApi(api_client)
    project_key = "projectKey_example" # str | The project key
    environment_key = "environmentKey_example" # str | The environment key
    integration_key = "integrationKey_example" # str | The integration key, either `redis` or `dynamodb`
    integration_id = "integrationId_example" # str | The integration ID
    json_patch = JSONPatch([
        PatchOperation(
            op="replace",
            path="/exampleField",
            value=None,
        ),
    ]) # JSONPatch | 

    # example passing only required values which don't have defaults set
    try:
        # Update big segment store integration
        api_response = api_instance.patch_big_segment_store_integration(project_key, environment_key, integration_key, integration_id, json_patch)
        pprint(api_response)
    except launchdarkly_api.ApiException as e:
        print("Exception when calling PersistentStoreIntegrationsBetaApi->patch_big_segment_store_integration: %s\n" % e)

Parameters

Name	Type	Description
project_key	str	The project key
environment_key	str	The environment key
integration_key	str	The integration key, either `redis` or `dynamodb`
integration_id	str	The integration ID
json_patch	JSONPatch

Return type

BigSegmentStoreIntegration

Authorization

ApiKey

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Big segment store response	-
400	Invalid request	-
401	Invalid access token	-
403	Forbidden	-
404	Environment or project not found	-
409	Status conflict	-
429	Rate limited	-

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

Files

PersistentStoreIntegrationsBetaApi.md

Latest commit

History

PersistentStoreIntegrationsBetaApi.md

File metadata and controls

launchdarkly_api.PersistentStoreIntegrationsBetaApi

create_big_segment_store_integration

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_big_segment_store_integration

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_big_segment_store_integration

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_big_segment_store_integrations

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

patch_big_segment_store_integration

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details