Update Data Export destination

For the complete documentation index, see llms.txt. For the full documentation snapshot, see llms-full.txt.

Update a Data Export destination. Uses a JSON patch or JSON merge patch representation of the desired changes.

PATCH /api/v2/destinations/{projectKey}/{environmentKey}/{id}

Update Data Export destination

cURL

curl --request PATCH \
  --url https://app.launchdarkly.com/api/v2/destinations/{projectKey}/{environmentKey}/{id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "op": "replace",
    "path": "/config/topic",
    "value": "ld-pubsub-test-192302"
  }
]
'

200

{
  "_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,
  "_access": {
    "denied": [
      {
        "action": "<string>",
        "reason": {
          "effect": "allow",
          "resources": [
            "proj/*:env/*;qa_*:/flag/*"
          ],
          "notResources": [
            "<string>"
          ],
          "actions": [
            "*"
          ],
          "notActions": [
            "<string>"
          ],
          "role_name": "<string>"
        }
      }
    ],
    "allowed": [
      {
        "action": "<string>",
        "reason": {
          "effect": "allow",
          "resources": [
            "proj/*:env/*;qa_*:/flag/*"
          ],
          "notResources": [
            "<string>"
          ],
          "actions": [
            "*"
          ],
          "notActions": [
            "<string>"
          ],
          "role_name": "<string>"
        }
      }
    ]
  }
}

Authorizations

Authorization · string · header · required

Path Parameters

projectKey · string<string> · required

The project key

environmentKey · string<string> · required

The environment key

id · string<string> · required

The Data Export destination ID

Body

application/json

op · string · required

The type of operation to perform

Example:

"replace"

path · string · required

A JSON Pointer string specifying the part of the document to operate on

Example:

"/exampleField"

value · any

A JSON value used in "add", "replace", and "test" operations

Example:

"new example value"

Response

200

application/json

Destination response

_id · string

The ID of this Data Export destination

Example:

"610addeadbeefaa86ec9a7d4"

_links · object

The location and content type of related resources

Show child attributes

Example:

{
  "parent": {
    "href": "/api/v2/destinations",
    "type": "application/json"
  },
  "self": {
    "href": "/api/v2/destinations/my-project/my-environment/610addeadbeefaa86ec9a7d4",
    "type": "application/json"
  }
}

name · string

A human-readable name for your Data Export destination

Example:

"example-destination"

kind · enum<string>

The type of Data Export destination

Available options: google-pubsub, kinesis, mparticle, segment, azure-event-hubs, snowflake-v2, databricks, bigquery, redshift

Example:

"google-pubsub"

version · number

Example:

1

config · any

An object with the configuration parameters required for the destination type

Example:

"{\"project\":\"test-prod\",\"topic\":\"ld-pubsub-test-192301\"}"

on · boolean

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

Example:

true

_access · object

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

Show child attributes