v5

latestOpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2026-02-283466592.5 MB

Data Export destinations

Update Data Export destination

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.

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

Path parameters

projectKeystring string required

The project key

environmentKeystring string required

The environment key

idstring string required

The Data Export destination ID

Request body

opstring required

The type of operation to perform

pathstring required

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

valuestring

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

Example request

[
  {
    "op": "replace",
    "path": "/exampleField",
    "value": "new example value"
  }
]

Response

Destination response

_idstring

The ID of this Data Export destination

_linksobject

The location and content type of related resources

namestring

A human-readable name for your Data Export destination

The type of Data Export destination

versionnumber

configstring

An object with the configuration parameters required for the destination type

onboolean

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

Example response

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