Data Export destinations

Update Data Export destination

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

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.

Authorization

ApiKey read, write
Authorization<token>

In: header

Scope: read, write

Path Parameters

projectKey*string

The project key

Formatstring
environmentKey*string

The environment key

Formatstring
id*string

The Data Export destination ID

Formatstring

Request Body

application/json

[index: integer]?

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/api/v2/destinations/string/string/string" \  -H "Content-Type: application/json" \  -d '[    {      "op": "replace",      "path": "/config/topic",      "value": "ld-pubsub-test-192302"    }  ]'
{  "_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"  }}