Update Data Export destination

PATCH

/api/v2/destinations/:projectKey/:environmentKey/:id

PATCH

/api/v2/destinations/:projectKey/:environmentKey/:id

$ curl -X PATCH https://app.launchdarkly.com/api/v2/destinations/projectKey/environmentKey/id \
>      -H "Authorization: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '[
>   {
>     "op": "replace",
>     "path": "/config/topic",
>     "value": null
>   }
> ]'

1 {
2   "_id": "610addeadbeefaa86ec9a7d4",
3   "_links": {
4     "parent": {
5       "href": "/api/v2/destinations",
6       "type": "application/json"
7     },
8     "self": {
9       "href": "/api/v2/destinations/my-project/my-environment/610addeadbeefaa86ec9a7d4",
10       "type": "application/json"
11     }
12   },
13   "name": "example-destination",
14   "kind": "google-pubsub",
15   "version": 1,
16   "config": null,
17   "on": true,
18   "createdAt": 1628001602644,
19   "_access": {
20     "denied": [
21       {
22         "action": "string",
23         "reason": {
24           "effect": "allow",
25           "resources": [
26             "proj/*:env/*;qa_*:/flag/*"
27           ],
28           "notResources": [
29             "string"
30           ],
31           "actions": [
32             "*"
33           ],
34           "notActions": [
35             "string"
36           ],
37           "role_name": "string"
38         }
39       }
40     ],
41     "allowed": [
42       {
43         "action": "string",
44         "reason": {
45           "effect": "allow",
46           "resources": [
47             "proj/*:env/*;qa_*:/flag/*"
48           ],
49           "notResources": [
50             "string"
51           ],
52           "actions": [
53             "*"
54           ],
55           "notActions": [
56             "string"
57           ],
58           "role_name": "string"
59         }
60       }
61     ]
62   }
63 }

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.

Update a Data Export destination. Updating a destination uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) or [JSON merge patch](https://datatracker.ietf.org/doc/html/rfc7386) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates).

Authentication

Authorizationstring

API Key authentication via header

Path parameters

projectKeystringRequiredformat: "string"

The project key

environmentKeystringRequiredformat: "string"

The environment key

idstringRequiredformat: "string"

The Data Export destination ID

Request

This endpoint expects a list of objects.

Response

Destination response

_idstring

The ID of this Data Export destination

_linksmap from strings to objects

The location and content type of related resources

namestring

A human-readable name for your Data Export destination

kindenum

The type of Data Export destination

versiondouble

configany

An object with the configuration parameters required for the destination type

onboolean

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

createdAtlong

Timestamp of when the Data Export destination was created (as Unix milliseconds since epoch)

_accessobject

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

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

429

Too Many Requests Error