Data Export destinations

Generate warehouse destination setup script

Generate the SQL setup script required to prepare a warehouse for LaunchDarkly Data Export. For Snowflake, this also generates a key pair. Custom Snowflake object names may be provided. If omitted, defaults are used.

Authorization

ApiKey read, write

Authorization<token>

In: header

Scope: read, write

Path Parameters

projKey*string

The project key

Formatstring

envKey*string

The environment key

Formatstring

kind*string

The destination kind (snowflake-v2, redshift, clickhouse)

Formatstring

Request Body

application/json

name?string

snowflakeHostAddress?string

databaseName?string

warehouseName?string

roleName?string

schemaName?string

userName?string

includeNetworkPolicy?boolean

clusterIdentifier?string

clusterRegion?string

clusterAwsAccountId?string

endpoint?string

clickHouseDatabaseName?string

clickHouseUserName?string

clickHouseS3BucketName?string

clickHouseIncludeHostRestriction?boolean

clickHouseServiceRoleArn?string

clickHousePassword?string

s3BucketName?string

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

curl -X POST "https://example.com/api/v2/destinations/projects/string/environments/string/kinds/string/setup" \  -H "Content-Type: application/json" \  -d '{}'

{  "script": "string",  "publicKey": "string",  "publicKeyPkcs8": "string",  "redshiftIAMPermissionsPolicy": "string",  "redshiftIAMTrustPolicy": "string",  "s3BucketName": "string"}

Complete warehouse destination setup POST

Complete the setup of a warehouse destination by providing the Snowflake host address and the public keys from the /setup response. The custom names are read from the stored configuration.

Create Data Export destination POST

Create a new Data Export destination. In the `config` request body parameter, the fields required depend on the type of Data Export destination. <details> <summary>Click to expand <code>config</code> parameter details</summary> #### 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](https://launchdarkly.com/docs/api/data-export-destinations/post-generate-warehouse-destination-key-pair) response. It is the `public_key` field. * `snowflakeHostAddress`: Your Snowflake account URL. </details>