Create big segment store integration | LaunchDarkly

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

{
  "_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": 1,
        "message": "string",
        "timestamp": 1
      }
    ]
  },
  "_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"
        }
      }
    ]
  }
}

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.

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](https://launchdarkly.com/docs/home/flags/segment-config).

Authentication

Authorizationstring

API Key authentication via header

Path parameters

projectKeystringRequiredformat: "string"

The project key

environmentKeystringRequiredformat: "string"

The environment key

integrationKeystringRequiredformat: "string"

The integration key, either redis or dynamodb

Request

This endpoint expects an object.

configmap from strings to anyRequired

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

onbooleanOptional

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

tagslist of stringsOptional

Tags to associate with the integration

namestringOptional

Name to identify the integration

Response

Big segment store response

_linksobject

The location and content type of related resources

_idstring

The integration ID

integrationKeyenum

The integration key

Allowed values:

projectKeystring

The project key

environmentKeystring

The environment key

configmap from strings to any

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.

onboolean

Whether the configuration is turned on

tagslist of strings

List of tags for this configuration

namestring

Name of the configuration

versioninteger

Version of the current configuration

_statusobject

Details on the connection status of the persistent store integration

_accessobject

Details on the allowed and denied actions for this configuration

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

429

Too Many Requests Error

Create a persistent store integration.

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.