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.
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 namename: The Event Hub namepolicyName: 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 totopic: 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 keyroleArn: The Amazon Resource Name (ARN) of the AWS role that will be writing to KinesisstreamName: 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 keysecret: The mParticle API secretuserIdentity: The type of identifier you use to identify your end users in mParticleanonymousUserIdentity: 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: ThepublicKeyis returned as part of the Generate Snowflake destination key pair response. It is thepublic_keyfield.snowflakeHostAddress: Your Snowflake account URL.
Authorization
ApiKey read, writeIn: header
Scope: read, write
Path Parameters
The project key
stringThe environment key
stringRequest Body
application/json
A human-readable name for your Data Export destination
The type of Data Export destination
Value in
- "google-pubsub"
- "kinesis"
- "mparticle"
- "segment"
- "azure-event-hubs"
- "snowflake-v2"
- "databricks"
- "bigquery"
- "redshift"
An object with the configuration parameters required for the destination type
Whether the export is on. Displayed as the integration status in the LaunchDarkly UI.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/api/v2/destinations/string/string" \ -H "Content-Type: application/json" \ -d '{ "config": { "project": "test-prod", "topic": "ld-pubsub-test-192301" }, "kind": "google-pubsub" }'{ "_id": "610addeadbeefaa86ec9a7d4", "_links": { "parent": { "href": "/api/v2/destinations", "type": "application/json" }, "self": { "href": "/api/v2/destinations/my-project/my-environment/610addeadbeefaa86ec9a7d4", "type": "application/json" } }, "name": "example-destination", "kind": "google-pubsub", "version": 1, "config": "{\"project\":\"test-prod\",\"topic\":\"ld-pubsub-test-192301\"}", "on": true, "createdAt": "1628001602644", "maintainerId": "569f183514f4432160000007", "_access": { "denied": [ { "action": "string", "reason": { "resources": [ "proj/*:env/*;qa_*:/flag/*" ], "notResources": [ "string" ], "actions": [ "*" ], "notActions": [ "string" ], "effect": "allow", "role_name": "string" } } ], "allowed": [ { "action": "string", "reason": { "resources": [ "proj/*:env/*;qa_*:/flag/*" ], "notResources": [ "string" ], "actions": [ "*" ], "notActions": [ "string" ], "effect": "allow", "role_name": "string" } } ] }, "completedArtifacts": { "sqlSetupScript": "string", "s3BucketName": "string" }}Generate warehouse destination setup script POST
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.
Get destination GET
Get a single Data Export destination by ID.