For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Sign inTry it free
DocsGuidesSDKsIntegrationsAPI docsTutorialsFlagship blog
DocsGuidesSDKsIntegrationsAPI docsTutorialsFlagship blog
  • REST API overview
    • Access Tokens
    • Account Members
    • Account Usage Beta
    • AI Configs
    • Announcements
    • Applications Beta
    • Approvals
    • Approvals Beta
    • Audit Log
    • Code References
    • Contexts
    • Context Settings
    • Custom Roles
    • Data Export Destinations
    • Environments
    • Experiments
    • Feature Flags
    • Feature Flags Beta
    • Flag Import Configurations Beta
    • Flag Links Beta
    • Flag Triggers
    • Follow Flags
    • Holdouts Beta
    • Insights Charts Beta
    • Insights Deployments Beta
    • Insights Flag Events Beta
    • Insights Pull Requests Beta
    • Insights Repositories Beta
    • Insights Scores Beta
    • Integration Audit Log Subscriptions
    • Integration Delivery Configurations Beta
    • Integrations Beta
    • Layers
    • Metrics
    • Metrics Beta
    • OAuth2 Clients
    • Persistent Store Integrations Beta
      • POSTCreate big segment store integration
      • DELDelete big segment store integration
      • GETGet big segment store integration by ID
      • GETList all big segment store integrations
      • PATCHUpdate big segment store integration
    • Projects
    • Relay Proxy Configurations
    • Release Pipelines Beta
    • Releases Beta
    • Scheduled Changes
    • Segments
    • Tags
    • Teams
    • Teams Beta
    • Users
    • Users Beta
    • User Settings
    • Views Beta
    • Webhooks
    • Workflows
    • Workflow Templates
    • Other
Sign inTry it free
LogoLogo
REST API overviewPersistent Store Integrations Beta

Get big segment store integration by ID

GET
/api/v2/integration-capabilities/big-segment-store/:projectKey/:environmentKey/:integrationKey/:integrationId
GET
/api/v2/integration-capabilities/big-segment-store/:projectKey/:environmentKey/:integrationKey/:integrationId
$curl https://app.launchdarkly.com/api/v2/integration-capabilities/big-segment-store/projectKey/environmentKey/integrationKey/integrationId \
>     -H "Authorization: <apiKey>"
1{
2  "_links": {
3    "self": {
4      "href": "string",
5      "type": "string"
6    },
7    "parent": {
8      "href": "string",
9      "type": "string"
10    },
11    "project": {
12      "href": "string",
13      "type": "string"
14    },
15    "environment": {
16      "href": "string",
17      "type": "string"
18    }
19  },
20  "_id": "12ab3c4d5ef1a2345bcde67f",
21  "integrationKey": "redis",
22  "projectKey": "default",
23  "environmentKey": "development",
24  "config": {},
25  "on": true,
26  "tags": [],
27  "name": "Development environment configuration",
28  "version": 1,
29  "_status": {
30    "available": true,
31    "potentiallyStale": false,
32    "lastSync": 1717263000000,
33    "lastError": 1714584600000,
34    "errors": [
35      {
36        "statusCode": 1,
37        "message": "string",
38        "timestamp": 1
39      }
40    ]
41  },
42  "_access": {
43    "denied": [
44      {
45        "action": "string",
46        "reason": {
47          "effect": "allow",
48          "resources": [
49            "proj/*:env/*;qa_*:/flag/*"
50          ],
51          "notResources": [
52            "string"
53          ],
54          "actions": [
55            "*"
56          ],
57          "notActions": [
58            "string"
59          ],
60          "role_name": "string"
61        }
62      }
63    ],
64    "allowed": [
65      {
66        "action": "string",
67        "reason": {
68          "effect": "allow",
69          "resources": [
70            "proj/*:env/*;qa_*:/flag/*"
71          ],
72          "notResources": [
73            "string"
74          ],
75          "actions": [
76            "*"
77          ],
78          "notActions": [
79            "string"
80          ],
81          "role_name": "string"
82        }
83      }
84    ]
85  }
86}
Get a big segment store integration by ID.
Was this page helpful?
Previous

List all big segment store integrations

Next
Built with

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

integrationIdstringRequiredformat: "string"
The integration ID

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

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error