Create big segment store integration

For the complete documentation index, see llms.txt. For the full documentation snapshot, see llms-full.txt.

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}

Create big segment store integration

cURL

curl --request POST \
  --url https://app.launchdarkly.com/api/v2/integration-capabilities/big-segment-store/{projectKey}/{environmentKey}/{integrationKey} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "config": {
    "optional": "example value for optional formVariables property for sample-integration",
    "required": "example value for required formVariables property for sample-integration"
  },
  "name": "Example persistent store integration",
  "on": false,
  "tags": [
    "example-tag"
  ]
}
'

201

{
  "_links": {
    "self": {
      "href": "<string>",
      "type": "<string>"
    },
    "parent": {
      "href": "<string>",
      "type": "<string>"
    },
    "project": {
      "href": "<string>",
      "type": "<string>"
    },
    "environment": {
      "href": "<string>",
      "type": "<string>"
    }
  },
  "_id": "12ab3c4d5ef1a2345bcde67f",
  "integrationKey": "redis",
  "projectKey": "default",
  "environmentKey": "development",
  "config": {},
  "on": true,
  "tags": [],
  "name": "Development environment configuration",
  "version": 1,
  "_status": {
    "available": true,
    "potentiallyStale": false,
    "lastSync": "1717263000000",
    "lastError": "1714584600000",
    "errors": [
      {
        "statusCode": 123,
        "message": "<string>",
        "timestamp": 123
      }
    ]
  },
  "_access": {
    "denied": [
      {
        "action": "<string>",
        "reason": {
          "effect": "allow",
          "resources": [
            "proj/*:env/*;qa_*:/flag/*"
          ],
          "notResources": [
            "<string>"
          ],
          "actions": [
            "*"
          ],
          "notActions": [
            "<string>"
          ],
          "role_name": "<string>"
        }
      }
    ],
    "allowed": [
      {
        "action": "<string>",
        "reason": {
          "effect": "allow",
          "resources": [
            "proj/*:env/*;qa_*:/flag/*"
          ],
          "notResources": [
            "<string>"
          ],
          "actions": [
            "*"
          ],
          "notActions": [
            "<string>"
          ],
          "role_name": "<string>"
        }
      }
    ]
  }
}

Authorizations

Authorization · string · header · required

Path Parameters

projectKey · string<string> · required

The project key

environmentKey · string<string> · required

The environment key

integrationKey · string<string> · required

The integration key, either redis or dynamodb

Body

application/json

config · object · required

The global integration settings, as specified by the formVariables in the manifest.json for this integration.

Show child attributes

Example:

"{\"required\": \"example value for required formVariables property for sample-integration\", \"optional\": \"example value for optional formVariables property for sample-integration\"}"

on · boolean

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

Example:

false

tags · string[]

Tags to associate with the integration

Example:

["example-tag"]

name · string

Name to identify the integration

Example:

"Sample integration"

Response

201

application/json

Big segment store response

_links · object · required

The location and content type of related resources

Show child attributes

_id · string · required

The integration ID

Example:

"12ab3c4d5ef1a2345bcde67f"

integrationKey · enum<string> · required

The integration key

Available options: redis, dynamodb

Example:

"redis"

projectKey · string · required

The project key

Example:

"default"

environmentKey · string · required

The environment key

Example:

"development"

config · object · required

The delivery configuration for the given integration provider. Only included when requesting a single integration by ID. Refer to the formVariables field in the corresponding manifest.json for a full list of fields for each integration.

Show child attributes

on · boolean · required

Whether the configuration is turned on

Example:

true

tags · string[] · required

List of tags for this configuration

Example:

[]

name · string · required

Name of the configuration

Example:

"Development environment configuration"

version · integer · required

Version of the current configuration

Example:

1

_status · object · required

Details on the connection status of the persistent store integration

Show child attributes

_access · object

Details on the allowed and denied actions for this configuration

Show child attributes