LaunchDarklyApi\DataExportDestinationsApi

All URIs are relative to https://app.launchdarkly.com, except if the operation defines another base path.

Method	HTTP request	Description
deleteDestination()	DELETE /api/v2/destinations/{projectKey}/{environmentKey}/{id}	Delete Data Export destination
getDestination()	GET /api/v2/destinations/{projectKey}/{environmentKey}/{id}	Get destination
getDestinations()	GET /api/v2/destinations	List destinations
patchDestination()	PATCH /api/v2/destinations/{projectKey}/{environmentKey}/{id}	Update Data Export destination
postDestination()	POST /api/v2/destinations/{projectKey}/{environmentKey}	Create Data Export destination
postGenerateTrustPolicy()	POST /api/v2/destinations/projects/{projKey}/environments/{envKey}/generate-trust-policy	Generate trust policy
postGenerateWarehouseDestinationKeyPair()	POST /api/v2/destinations/generate-warehouse-destination-key-pair	Generate Snowflake destination key pair

`deleteDestination()`

deleteDestination($project_key, $environment_key, $id)

Delete Data Export destination

Delete a Data Export destination by ID.

Example

<?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\DataExportDestinationsApi(
    // 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
$id = 'id_example'; // string | The Data Export destination ID

try {
    $apiInstance->deleteDestination($project_key, $environment_key, $id);
} catch (Exception $e) {
    echo 'Exception when calling DataExportDestinationsApi->deleteDestination: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description
project_key	string	The project key
environment_key	string	The environment key
id	string	The Data Export destination ID

Return type

void (empty response body)

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getDestination()`

getDestination($project_key, $environment_key, $id): \LaunchDarklyApi\Model\Destination

Get destination

Get a single Data Export destination by ID.

Example

<?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\DataExportDestinationsApi(
    // 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
$id = 'id_example'; // string | The Data Export destination ID

try {
    $result = $apiInstance->getDestination($project_key, $environment_key, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataExportDestinationsApi->getDestination: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description
project_key	string	The project key
environment_key	string	The environment key
id	string	The Data Export destination ID

Return type

\LaunchDarklyApi\Model\Destination

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getDestinations()`

getDestinations(): \LaunchDarklyApi\Model\Destinations

List destinations

Get a list of Data Export destinations configured across all projects and environments.

Example

<?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\DataExportDestinationsApi(
    // 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->getDestinations();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataExportDestinationsApi->getDestinations: ', $e->getMessage(), PHP_EOL;
}

Parameters

This endpoint does not need any parameter.

Return type

\LaunchDarklyApi\Model\Destinations

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`patchDestination()`

patchDestination($project_key, $environment_key, $id, $patch_operation): \LaunchDarklyApi\Model\Destination

Update Data Export destination

Update a Data Export destination. Updating a destination uses a JSON patch or JSON merge patch representation of the desired changes. To learn more, read Updates.

Example

<?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\DataExportDestinationsApi(
    // 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
$id = 'id_example'; // string | The Data Export destination ID
$patch_operation = [{"op":"replace","path":"/config/topic","value":"ld-pubsub-test-192302"}]; // \LaunchDarklyApi\Model\PatchOperation[]

try {
    $result = $apiInstance->patchDestination($project_key, $environment_key, $id, $patch_operation);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataExportDestinationsApi->patchDestination: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description
project_key	string	The project key
environment_key	string	The environment key
id	string	The Data Export destination ID
patch_operation	\LaunchDarklyApi\Model\PatchOperation[]

Return type

\LaunchDarklyApi\Model\Destination

Authorization

ApiKey

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`postDestination()`

postDestination($project_key, $environment_key, $destination_post): \LaunchDarklyApi\Model\Destination

Create Data Export destination

Create a new Data Export destination. In the config request body parameter, the fields required depend on the type of Data Export destination.

Click to expand config parameter details

#### Azure Event Hubs To create a Data Export destination with a kind of azure-event-hubs, the config object requires the following fields: * namespace: The Event Hub Namespace name * name: The Event Hub name * policyName: The shared access signature policy name. You can find your policy name in the settings of your Azure Event Hubs Namespace. * policyKey: The shared access signature key. You can find your policy key in the settings of your Azure Event Hubs Namespace. #### Google Cloud Pub/Sub To create a Data Export destination with a kind of google-pubsub, the config object requires the following fields: * project: The Google PubSub project ID for the project to publish to * topic: The Google PubSub topic ID for the topic to publish to #### Amazon Kinesis To create a Data Export destination with a kind of kinesis, the config object requires the following fields: * region: The Kinesis stream's AWS region key * roleArn: The Amazon Resource Name (ARN) of the AWS role that will be writing to Kinesis * streamName: The name of the Kinesis stream that LaunchDarkly is sending events to. This is not the ARN of the stream. #### mParticle To create a Data Export destination with a kind of mparticle, the config object requires the following fields: * apiKey: The mParticle API key * secret: The mParticle API secret * userIdentity: The type of identifier you use to identify your end users in mParticle * anonymousUserIdentity: The type of identifier you use to identify your anonymous end users in mParticle #### Segment To create a Data Export destination with a kind of segment, the config object requires the following fields: * writeKey: The Segment write key. This is used to authenticate LaunchDarkly's calls to Segment. #### Snowflake To create a Data Export destination with a kind of snowflake-v2, the config object requires the following fields: * publicKey: The publicKey is returned as part of the Generate Snowflake destination key pair response. It is the public_key field. * snowflakeHostAddress: Your Snowflake account URL.

Example

<?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\DataExportDestinationsApi(
    // 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
$destination_post = {"config":{"project":"test-prod","topic":"ld-pubsub-test-192301"},"kind":"google-pubsub"}; // \LaunchDarklyApi\Model\DestinationPost

try {
    $result = $apiInstance->postDestination($project_key, $environment_key, $destination_post);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataExportDestinationsApi->postDestination: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description
project_key	string	The project key
environment_key	string	The environment key
destination_post	\LaunchDarklyApi\Model\DestinationPost

Return type

\LaunchDarklyApi\Model\Destination

Authorization

ApiKey

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`postGenerateTrustPolicy()`

postGenerateTrustPolicy($proj_key, $env_key): \LaunchDarklyApi\Model\GenerateTrustPolicyPostRep

Generate trust policy

Trust policy to allow Data Export to assume the role and perform operations on AWS resources

Example

<?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\DataExportDestinationsApi(
    // 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
);
$proj_key = 'proj_key_example'; // string | The project key
$env_key = 'env_key_example'; // string | The environment key

try {
    $result = $apiInstance->postGenerateTrustPolicy($proj_key, $env_key);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataExportDestinationsApi->postGenerateTrustPolicy: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
proj_key	string	The project key
env_key	string	The environment key

Return type

\LaunchDarklyApi\Model\GenerateTrustPolicyPostRep

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`postGenerateWarehouseDestinationKeyPair()`

postGenerateWarehouseDestinationKeyPair(): \LaunchDarklyApi\Model\GenerateWarehouseDestinationKeyPairPostRep

Generate Snowflake destination key pair

Generate key pair to allow Data Export to authenticate into a Snowflake warehouse destination

Example

<?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\DataExportDestinationsApi(
    // 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->postGenerateWarehouseDestinationKeyPair();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataExportDestinationsApi->postGenerateWarehouseDestinationKeyPair: ', $e->getMessage(), PHP_EOL;
}

Parameters

This endpoint does not need any parameter.

Return type

\LaunchDarklyApi\Model\GenerateWarehouseDestinationKeyPairPostRep

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FilesExpand file tree

DataExportDestinationsApi.md

Latest commit

History

DataExportDestinationsApi.md

File metadata and controls

LaunchDarklyApi\DataExportDestinationsApi

deleteDestination()

Example

Parameters

Return type

Authorization

HTTP request headers

getDestination()

Example

Parameters

Return type

Authorization

HTTP request headers

getDestinations()

Example

Parameters

Return type

Authorization

HTTP request headers

patchDestination()

Example

Parameters

Return type

Authorization

HTTP request headers

postDestination()

Example

Parameters

Return type

Authorization

HTTP request headers

postGenerateTrustPolicy()

Example

Parameters

Return type

Authorization

HTTP request headers

postGenerateWarehouseDestinationKeyPair()

Example

Parameters

Return type

Authorization

HTTP request headers

`deleteDestination()`

`getDestination()`

`getDestinations()`

`patchDestination()`

`postDestination()`

`postGenerateTrustPolicy()`

`postGenerateWarehouseDestinationKeyPair()`