v5

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

Persistent store integrations (beta)

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.

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

Path parameters

projectKeystring string required

The project key

environmentKeystring string required

The environment key

integrationKeystring string required

The integration key, either redis or dynamodb

integrationIdstring string required

The integration ID

Request body

opstring required

The type of operation to perform

pathstring required

A JSON Pointer string specifying the part of the document to operate on

valuestring

A JSON value used in "add", "replace", and "test" operations

Example request

[
  {
    "op": "replace",
    "path": "/exampleField",
    "value": "new example value"
  }
]

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
  }
}