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 |
createFlagImportConfiguration() | POST /api/v2/integration-capabilities/flag-import/{projectKey}/{integrationKey} | Create a flag import configuration |
deleteBigSegmentStoreIntegration() | DELETE /api/v2/integration-capabilities/big-segment-store/{projectKey}/{environmentKey}/{integrationKey}/{integrationId} | Delete big segment store integration |
deleteFlagImportConfiguration() | DELETE /api/v2/integration-capabilities/flag-import/{projectKey}/{integrationKey}/{integrationId} | Delete a flag import configuration |
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 |
getFlagImportConfiguration() | GET /api/v2/integration-capabilities/flag-import/{projectKey}/{integrationKey}/{integrationId} | Get a single flag import configuration |
getFlagImportConfigurations() | GET /api/v2/integration-capabilities/flag-import | List all flag import configurations |
patchBigSegmentStoreIntegration() | PATCH /api/v2/integration-capabilities/big-segment-store/{projectKey}/{environmentKey}/{integrationKey}/{integrationId} | Update big segment store integration |
patchFlagImportConfiguration() | PATCH /api/v2/integration-capabilities/flag-import/{projectKey}/{integrationKey}/{integrationId} | Update a flag import configuration |
triggerFlagImportJob() | POST /api/v2/integration-capabilities/flag-import/{projectKey}/{integrationKey}/{integrationId}/trigger | Trigger a single flag import run |
createBigSegmentStoreIntegration($project_key, $environment_key, $integration_key, $integration_delivery_configuration_post): \LaunchDarklyApi\Model\BigSegmentStoreIntegration
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.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: ApiKey
$config = LaunchDarklyApi\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = LaunchDarklyApi\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');
$apiInstance = new LaunchDarklyApi\Api\IntegrationsBetaApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$project_key = 'project_key_example'; // string | The project key
$environment_key = 'environment_key_example'; // string | The environment key
$integration_key = 'integration_key_example'; // string | The integration key, either `redis` or `dynamodb`
$integration_delivery_configuration_post = {"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"]}; // \LaunchDarklyApi\Model\IntegrationDeliveryConfigurationPost
try {
$result = $apiInstance->createBigSegmentStoreIntegration($project_key, $environment_key, $integration_key, $integration_delivery_configuration_post);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling IntegrationsBetaApi->createBigSegmentStoreIntegration: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
project_key | string | The project key | |
environment_key | string | The environment key | |
integration_key | string | The integration key, either `redis` or `dynamodb` | |
integration_delivery_configuration_post | \LaunchDarklyApi\Model\IntegrationDeliveryConfigurationPost |
\LaunchDarklyApi\Model\BigSegmentStoreIntegration
- Content-Type:
application/json
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
createFlagImportConfiguration($project_key, $integration_key, $flag_import_configuration_post): \LaunchDarklyApi\Model\FlagImportIntegration
Create a flag import configuration
Create a new flag import configuration. The integrationKey
path parameter identifies the feature management system from which the import occurs, for example, split
. The config
object in the request body schema is described by the global integration settings, as specified by the formVariables
in the manifest.json
for this integration. It varies slightly based on the integrationKey
.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: ApiKey
$config = LaunchDarklyApi\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = LaunchDarklyApi\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');
$apiInstance = new LaunchDarklyApi\Api\IntegrationsBetaApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$project_key = 'project_key_example'; // string | The project key
$integration_key = 'integration_key_example'; // string | The integration key
$flag_import_configuration_post = {"config":{"environmentId":"The ID of the environment in the external system","ldApiKey":"An API key with create flag permissions in your LaunchDarkly account","ldMaintainer":"The ID of the member who will be the maintainer of the imported flags","ldTag":"A tag to apply to all flags imported to LaunchDarkly","splitTag":"If provided, imports only the flags from the external system with this tag. Leave blank to import all flags.","workspaceApiKey":"An API key with read permissions in the external feature management system","workspaceId":"The ID of the workspace in the external system"},"name":"Sample configuration","tags":["example-tag"]}; // \LaunchDarklyApi\Model\FlagImportConfigurationPost
try {
$result = $apiInstance->createFlagImportConfiguration($project_key, $integration_key, $flag_import_configuration_post);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling IntegrationsBetaApi->createFlagImportConfiguration: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
project_key | string | The project key | |
integration_key | string | The integration key | |
flag_import_configuration_post | \LaunchDarklyApi\Model\FlagImportConfigurationPost |
\LaunchDarklyApi\Model\FlagImportIntegration
- Content-Type:
application/json
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
deleteBigSegmentStoreIntegration($project_key, $environment_key, $integration_key, $integration_id)
Delete big segment store integration
Delete a persistent store integration. Each integration uses either Redis or DynamoDB.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: ApiKey
$config = LaunchDarklyApi\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = LaunchDarklyApi\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');
$apiInstance = new LaunchDarklyApi\Api\IntegrationsBetaApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$project_key = 'project_key_example'; // string | The project key
$environment_key = 'environment_key_example'; // string | The environment key
$integration_key = 'integration_key_example'; // string | The integration key, either `redis` or `dynamodb`
$integration_id = 'integration_id_example'; // string | The integration ID
try {
$apiInstance->deleteBigSegmentStoreIntegration($project_key, $environment_key, $integration_key, $integration_id);
} catch (Exception $e) {
echo 'Exception when calling IntegrationsBetaApi->deleteBigSegmentStoreIntegration: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
project_key | string | The project key | |
environment_key | string | The environment key | |
integration_key | string | The integration key, either `redis` or `dynamodb` | |
integration_id | string | The integration ID |
void (empty response body)
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
deleteFlagImportConfiguration($project_key, $integration_key, $integration_id)
Delete a flag import configuration
Delete a flag import configuration by ID. The integrationKey
path parameter identifies the feature management system from which the import occurs, for example, split
.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: ApiKey
$config = LaunchDarklyApi\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = LaunchDarklyApi\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');
$apiInstance = new LaunchDarklyApi\Api\IntegrationsBetaApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$project_key = 'project_key_example'; // string | The project key
$integration_key = 'integration_key_example'; // string | The integration key
$integration_id = 'integration_id_example'; // string | The integration ID
try {
$apiInstance->deleteFlagImportConfiguration($project_key, $integration_key, $integration_id);
} catch (Exception $e) {
echo 'Exception when calling IntegrationsBetaApi->deleteFlagImportConfiguration: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
project_key | string | The project key | |
integration_key | string | The integration key | |
integration_id | string | The integration ID |
void (empty response body)
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getBigSegmentStoreIntegration($project_key, $environment_key, $integration_key, $integration_id): \LaunchDarklyApi\Model\BigSegmentStoreIntegration
Get big segment store integration by ID
Get a big segment store integration by ID.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: ApiKey
$config = LaunchDarklyApi\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = LaunchDarklyApi\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');
$apiInstance = new LaunchDarklyApi\Api\IntegrationsBetaApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$project_key = 'project_key_example'; // string | The project key
$environment_key = 'environment_key_example'; // string | The environment key
$integration_key = 'integration_key_example'; // string | The integration key, either `redis` or `dynamodb`
$integration_id = 'integration_id_example'; // string | The integration ID
try {
$result = $apiInstance->getBigSegmentStoreIntegration($project_key, $environment_key, $integration_key, $integration_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling IntegrationsBetaApi->getBigSegmentStoreIntegration: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
project_key | string | The project key | |
environment_key | string | The environment key | |
integration_key | string | The integration key, either `redis` or `dynamodb` | |
integration_id | string | The integration ID |
\LaunchDarklyApi\Model\BigSegmentStoreIntegration
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getBigSegmentStoreIntegrations(): \LaunchDarklyApi\Model\BigSegmentStoreIntegrationCollection
List all big segment store integrations
List all big segment store integrations.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: ApiKey
$config = LaunchDarklyApi\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = LaunchDarklyApi\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');
$apiInstance = new LaunchDarklyApi\Api\IntegrationsBetaApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
try {
$result = $apiInstance->getBigSegmentStoreIntegrations();
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling IntegrationsBetaApi->getBigSegmentStoreIntegrations: ', $e->getMessage(), PHP_EOL;
}
This endpoint does not need any parameter.
\LaunchDarklyApi\Model\BigSegmentStoreIntegrationCollection
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getFlagImportConfiguration($project_key, $integration_key, $integration_id): \LaunchDarklyApi\Model\FlagImportIntegration
Get a single flag import configuration
Get a single flag import configuration by ID. The integrationKey
path parameter identifies the feature management system from which the import occurs, for example, split
.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: ApiKey
$config = LaunchDarklyApi\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = LaunchDarklyApi\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');
$apiInstance = new LaunchDarklyApi\Api\IntegrationsBetaApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$project_key = 'project_key_example'; // string | The project key
$integration_key = 'integration_key_example'; // string | The integration key, for example, `split`
$integration_id = 'integration_id_example'; // string | The integration ID
try {
$result = $apiInstance->getFlagImportConfiguration($project_key, $integration_key, $integration_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling IntegrationsBetaApi->getFlagImportConfiguration: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
project_key | string | The project key | |
integration_key | string | The integration key, for example, `split` | |
integration_id | string | The integration ID |
\LaunchDarklyApi\Model\FlagImportIntegration
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getFlagImportConfigurations(): \LaunchDarklyApi\Model\FlagImportIntegrationCollection
List all flag import configurations
List all flag import configurations.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: ApiKey
$config = LaunchDarklyApi\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = LaunchDarklyApi\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');
$apiInstance = new LaunchDarklyApi\Api\IntegrationsBetaApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
try {
$result = $apiInstance->getFlagImportConfigurations();
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling IntegrationsBetaApi->getFlagImportConfigurations: ', $e->getMessage(), PHP_EOL;
}
This endpoint does not need any parameter.
\LaunchDarklyApi\Model\FlagImportIntegrationCollection
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
patchBigSegmentStoreIntegration($project_key, $environment_key, $integration_key, $integration_id, $patch_operation): \LaunchDarklyApi\Model\BigSegmentStoreIntegration
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.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: ApiKey
$config = LaunchDarklyApi\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = LaunchDarklyApi\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');
$apiInstance = new LaunchDarklyApi\Api\IntegrationsBetaApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$project_key = 'project_key_example'; // string | The project key
$environment_key = 'environment_key_example'; // string | The environment key
$integration_key = 'integration_key_example'; // string | The integration key, either `redis` or `dynamodb`
$integration_id = 'integration_id_example'; // string | The integration ID
$patch_operation = array(new \LaunchDarklyApi\Model\PatchOperation()); // \LaunchDarklyApi\Model\PatchOperation[]
try {
$result = $apiInstance->patchBigSegmentStoreIntegration($project_key, $environment_key, $integration_key, $integration_id, $patch_operation);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling IntegrationsBetaApi->patchBigSegmentStoreIntegration: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
project_key | string | The project key | |
environment_key | string | The environment key | |
integration_key | string | The integration key, either `redis` or `dynamodb` | |
integration_id | string | The integration ID | |
patch_operation | \LaunchDarklyApi\Model\PatchOperation[] |
\LaunchDarklyApi\Model\BigSegmentStoreIntegration
- Content-Type:
application/json
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
patchFlagImportConfiguration($project_key, $integration_key, $integration_id, $patch_operation): \LaunchDarklyApi\Model\FlagImportIntegration
Update a flag import configuration
Updating a flag import configuration uses a JSON patch representation of the desired changes. To learn more, read Updates.
To add an element to the import configuration fields that are arrays, set the path
to the name of the field and then append /<array index>
. Use /0
to add to the beginning of the array. Use /-
to add to the end of the array.
You can update the config
, tags
, and name
of the flag import configuration.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: ApiKey
$config = LaunchDarklyApi\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = LaunchDarklyApi\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');
$apiInstance = new LaunchDarklyApi\Api\IntegrationsBetaApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$project_key = 'project_key_example'; // string | The project key
$integration_key = 'integration_key_example'; // string | The integration key
$integration_id = 'integration_id_example'; // string | The integration ID
$patch_operation = array(new \LaunchDarklyApi\Model\PatchOperation()); // \LaunchDarklyApi\Model\PatchOperation[]
try {
$result = $apiInstance->patchFlagImportConfiguration($project_key, $integration_key, $integration_id, $patch_operation);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling IntegrationsBetaApi->patchFlagImportConfiguration: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
project_key | string | The project key | |
integration_key | string | The integration key | |
integration_id | string | The integration ID | |
patch_operation | \LaunchDarklyApi\Model\PatchOperation[] |
\LaunchDarklyApi\Model\FlagImportIntegration
- Content-Type:
application/json
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
triggerFlagImportJob($project_key, $integration_key, $integration_id): object
Trigger a single flag import run
Trigger a single flag import run for an existing flag import configuration. The integrationKey
path parameter identifies the feature management system from which the import occurs, for example, split
.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: ApiKey
$config = LaunchDarklyApi\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = LaunchDarklyApi\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');
$apiInstance = new LaunchDarklyApi\Api\IntegrationsBetaApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$project_key = 'project_key_example'; // string | The project key
$integration_key = 'integration_key_example'; // string | The integration key
$integration_id = 'integration_id_example'; // string | The integration ID
try {
$result = $apiInstance->triggerFlagImportJob($project_key, $integration_key, $integration_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling IntegrationsBetaApi->triggerFlagImportJob: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
project_key | string | The project key | |
integration_key | string | The integration key | |
integration_id | string | The integration ID |
object
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]