v5

latestOpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2026-02-283466592.5 MB

Persistent store integrations (beta)

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.

post/api/v2/integration-capabilities/big-segment-store/{projectKey}/{environmentKey}/{integrationKey}

Path parameters

projectKeystring string required

The project key

environmentKeystring string required

The environment key

integrationKeystring string required

The integration key, either redis or dynamodb

Request body

onboolean

Whether the integration configuration is active. Default value is false.

configFormVariableConfig required

tagsstring[]

Tags to associate with the integration

namestring

Name to identify the integration

Example request

{
  "tags": [
    "example-tag"
  ],
  "name": "Sample integration"
}

Response

Big segment store response

_idstring required

The integration ID

integrationKey'redis' | 'dynamodb' required

The integration key

projectKeystring required

The project key

environmentKeystring required

The environment key

configFormVariableConfig required

onboolean required

Whether the configuration is turned on

tagsstring[] required

List of tags for this configuration

namestring required

Name of the configuration

versioninteger required

Version of the current configuration

Example response

{
  "_id": "12ab3c4d5ef1a2345bcde67f",
  "integrationKey": "redis",
  "projectKey": "default",
  "environmentKey": "development",
  "on": true,
  "tags": [],
  "name": "Development environment configuration",
  "version": 1,
  "_access": {
    "denied": [
      {
        "reason": {
          "resources": [
            "proj/*:env/*;qa_*:/flag/*"
          ],
          "actions": [
            "*"
          ],
          "effect": "allow"
        }
      }
    ],
    "allowed": [
      {
        "reason": {
          "resources": [
            "proj/*:env/*;qa_*:/flag/*"
          ],
          "actions": [
            "*"
          ],
          "effect": "allow"
        }
      }
    ]
  },
  "_status": {
    "available": true
  }
}