PersistentStoreIntegrationsBetaApi

All URIs are relative to https://app.launchdarkly.com

Method	HTTP request	Description
createBigSegmentStoreIntegration	POST /api/v2/integration-capabilities/big-segment-store/{projectKey}/{environmentKey}/{integrationKey}	Create big segment store integration
deleteBigSegmentStoreIntegration	DELETE /api/v2/integration-capabilities/big-segment-store/{projectKey}/{environmentKey}/{integrationKey}/{integrationId}	Delete big segment store integration
getBigSegmentStoreIntegration	GET /api/v2/integration-capabilities/big-segment-store/{projectKey}/{environmentKey}/{integrationKey}/{integrationId}	Get big segment store integration by ID
getBigSegmentStoreIntegrations	GET /api/v2/integration-capabilities/big-segment-store	List all big segment store integrations
patchBigSegmentStoreIntegration	PATCH /api/v2/integration-capabilities/big-segment-store/{projectKey}/{environmentKey}/{integrationKey}/{integrationId}	Update big segment store integration

createBigSegmentStoreIntegration

BigSegmentStoreIntegration createBigSegmentStoreIntegration(projectKey, environmentKey, integrationKey, integrationDeliveryConfigurationPost)

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.

Example

// Import classes:
import com.launchdarkly.api.ApiClient;
import com.launchdarkly.api.ApiException;
import com.launchdarkly.api.Configuration;
import com.launchdarkly.api.auth.*;
import com.launchdarkly.api.models.*;
import com.launchdarkly.api.api.PersistentStoreIntegrationsBetaApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://app.launchdarkly.com");
    
    // Configure API key authorization: ApiKey
    ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
    ApiKey.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKey.setApiKeyPrefix("Token");

    PersistentStoreIntegrationsBetaApi apiInstance = new PersistentStoreIntegrationsBetaApi(defaultClient);
    String projectKey = "projectKey_example"; // String | The project key
    String environmentKey = "environmentKey_example"; // String | The environment key
    String integrationKey = "integrationKey_example"; // String | The integration key, either `redis` or `dynamodb`
    IntegrationDeliveryConfigurationPost integrationDeliveryConfigurationPost = new IntegrationDeliveryConfigurationPost(); // IntegrationDeliveryConfigurationPost | 
    try {
      BigSegmentStoreIntegration result = apiInstance.createBigSegmentStoreIntegration(projectKey, environmentKey, integrationKey, integrationDeliveryConfigurationPost);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling PersistentStoreIntegrationsBetaApi#createBigSegmentStoreIntegration");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description
projectKey	String	The project key
environmentKey	String	The environment key
integrationKey	String	The integration key, either `redis` or `dynamodb`
integrationDeliveryConfigurationPost	IntegrationDeliveryConfigurationPost

Return type

BigSegmentStoreIntegration

Authorization

ApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Big segment store response	-
400	Invalid request	-
401	Invalid access token	-
403	Forbidden	-
404	Environment or project not found	-
409	Status conflict	-
429	Rate limited	-

deleteBigSegmentStoreIntegration

deleteBigSegmentStoreIntegration(projectKey, environmentKey, integrationKey, integrationId)

Delete big segment store integration

Delete a persistent store integration. Each integration uses either Redis or DynamoDB.

Example

// Import classes:
import com.launchdarkly.api.ApiClient;
import com.launchdarkly.api.ApiException;
import com.launchdarkly.api.Configuration;
import com.launchdarkly.api.auth.*;
import com.launchdarkly.api.models.*;
import com.launchdarkly.api.api.PersistentStoreIntegrationsBetaApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://app.launchdarkly.com");
    
    // Configure API key authorization: ApiKey
    ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
    ApiKey.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKey.setApiKeyPrefix("Token");

    PersistentStoreIntegrationsBetaApi apiInstance = new PersistentStoreIntegrationsBetaApi(defaultClient);
    String projectKey = "projectKey_example"; // String | The project key
    String environmentKey = "environmentKey_example"; // String | The environment key
    String integrationKey = "integrationKey_example"; // String | The integration key, either `redis` or `dynamodb`
    String integrationId = "integrationId_example"; // String | The integration ID
    try {
      apiInstance.deleteBigSegmentStoreIntegration(projectKey, environmentKey, integrationKey, integrationId);
    } catch (ApiException e) {
      System.err.println("Exception when calling PersistentStoreIntegrationsBetaApi#deleteBigSegmentStoreIntegration");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description
projectKey	String	The project key
environmentKey	String	The environment key
integrationKey	String	The integration key, either `redis` or `dynamodb`
integrationId	String	The integration ID

Return type

null (empty response body)

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	Action completed successfully	-
401	Invalid access token	-
403	Forbidden	-
404	Environment or project not found	-
409	Status conflict	-
429	Rate limited	-

getBigSegmentStoreIntegration

BigSegmentStoreIntegration getBigSegmentStoreIntegration(projectKey, environmentKey, integrationKey, integrationId)

Get big segment store integration by ID

Get a big segment store integration by ID.

Example

// Import classes:
import com.launchdarkly.api.ApiClient;
import com.launchdarkly.api.ApiException;
import com.launchdarkly.api.Configuration;
import com.launchdarkly.api.auth.*;
import com.launchdarkly.api.models.*;
import com.launchdarkly.api.api.PersistentStoreIntegrationsBetaApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://app.launchdarkly.com");
    
    // Configure API key authorization: ApiKey
    ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
    ApiKey.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKey.setApiKeyPrefix("Token");

    PersistentStoreIntegrationsBetaApi apiInstance = new PersistentStoreIntegrationsBetaApi(defaultClient);
    String projectKey = "projectKey_example"; // String | The project key
    String environmentKey = "environmentKey_example"; // String | The environment key
    String integrationKey = "integrationKey_example"; // String | The integration key, either `redis` or `dynamodb`
    String integrationId = "integrationId_example"; // String | The integration ID
    try {
      BigSegmentStoreIntegration result = apiInstance.getBigSegmentStoreIntegration(projectKey, environmentKey, integrationKey, integrationId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling PersistentStoreIntegrationsBetaApi#getBigSegmentStoreIntegration");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description
projectKey	String	The project key
environmentKey	String	The environment key
integrationKey	String	The integration key, either `redis` or `dynamodb`
integrationId	String	The integration ID

Return type

BigSegmentStoreIntegration

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Big segment store response	-
401	Invalid access token	-
403	Forbidden	-
404	Environment or project not found	-
429	Rate limited	-

getBigSegmentStoreIntegrations

BigSegmentStoreIntegrationCollection getBigSegmentStoreIntegrations()

List all big segment store integrations

List all big segment store integrations.

Example

// Import classes:
import com.launchdarkly.api.ApiClient;
import com.launchdarkly.api.ApiException;
import com.launchdarkly.api.Configuration;
import com.launchdarkly.api.auth.*;
import com.launchdarkly.api.models.*;
import com.launchdarkly.api.api.PersistentStoreIntegrationsBetaApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://app.launchdarkly.com");
    
    // Configure API key authorization: ApiKey
    ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
    ApiKey.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKey.setApiKeyPrefix("Token");

    PersistentStoreIntegrationsBetaApi apiInstance = new PersistentStoreIntegrationsBetaApi(defaultClient);
    try {
      BigSegmentStoreIntegrationCollection result = apiInstance.getBigSegmentStoreIntegrations();
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling PersistentStoreIntegrationsBetaApi#getBigSegmentStoreIntegrations");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

This endpoint does not need any parameter.

Return type

BigSegmentStoreIntegrationCollection

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Big segment store collection response	-
401	Invalid access token	-
403	Forbidden	-
404	Environment or project not found	-
429	Rate limited	-

patchBigSegmentStoreIntegration

BigSegmentStoreIntegration patchBigSegmentStoreIntegration(projectKey, environmentKey, integrationKey, integrationId, patchOperation)

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.

Example

// Import classes:
import com.launchdarkly.api.ApiClient;
import com.launchdarkly.api.ApiException;
import com.launchdarkly.api.Configuration;
import com.launchdarkly.api.auth.*;
import com.launchdarkly.api.models.*;
import com.launchdarkly.api.api.PersistentStoreIntegrationsBetaApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://app.launchdarkly.com");
    
    // Configure API key authorization: ApiKey
    ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
    ApiKey.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKey.setApiKeyPrefix("Token");

    PersistentStoreIntegrationsBetaApi apiInstance = new PersistentStoreIntegrationsBetaApi(defaultClient);
    String projectKey = "projectKey_example"; // String | The project key
    String environmentKey = "environmentKey_example"; // String | The environment key
    String integrationKey = "integrationKey_example"; // String | The integration key, either `redis` or `dynamodb`
    String integrationId = "integrationId_example"; // String | The integration ID
    List<PatchOperation> patchOperation = Arrays.asList(); // List<PatchOperation> | 
    try {
      BigSegmentStoreIntegration result = apiInstance.patchBigSegmentStoreIntegration(projectKey, environmentKey, integrationKey, integrationId, patchOperation);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling PersistentStoreIntegrationsBetaApi#patchBigSegmentStoreIntegration");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description
projectKey	String	The project key
environmentKey	String	The environment key
integrationKey	String	The integration key, either `redis` or `dynamodb`
integrationId	String	The integration ID
patchOperation	List<PatchOperation>

Return type

BigSegmentStoreIntegration

Authorization

ApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Big segment store response	-
400	Invalid request	-
401	Invalid access token	-
403	Forbidden	-
404	Environment or project not found	-
409	Status conflict	-
429	Rate limited	-

Files

PersistentStoreIntegrationsBetaApi.md

Latest commit

History

PersistentStoreIntegrationsBetaApi.md

File metadata and controls

PersistentStoreIntegrationsBetaApi

createBigSegmentStoreIntegration

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

deleteBigSegmentStoreIntegration

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getBigSegmentStoreIntegration

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getBigSegmentStoreIntegrations

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

patchBigSegmentStoreIntegration

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details