Create Data Export destination

POST
/api/v2/destinations/:projectKey/:environmentKey

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.

Path parameters

projectKeystringRequired

The project key

environmentKeystringRequired

The environment key

Request

This endpoint expects an object.
namestringOptional

A human-readable name for your Data Export destination

kindenumOptional

The type of Data Export destination

configanyOptional
onbooleanOptional

Whether the export is on. Displayed as the integration status in the LaunchDarkly UI.

Response

Destination response

_idstringOptional

The ID of this Data Export destination

namestringOptional

A human-readable name for your Data Export destination

kindenumOptional

The type of Data Export destination

versiondoubleOptional
configanyOptional
onbooleanOptional

Whether the export is on, that is, the status of the integration

_accessobjectOptional

Details on the allowed and denied actions for this Data Export destination

Errors

Built with