Versions API - Ours Privacy

Manage configuration versions. Create, list, find, and update versions to publish destination, source, and mapping changes to your live deployment.

Manage configuration versions. Create, list, find, and update versions in your account.

Tag Manager tags, triggers, and variables are draft changes. POST /rest/v1/versions accepts includeTagManagerTags, includeTagManagerTriggers, and includeTagManagerVariables allowlists for scoped publishing.

To check a single entity instead of the whole draft, use GET /rest/v1/versions/draft/status?collection={collection}&entityId={id}. It returns added, modified, removed, or null for that one entity, with the same semantics as GET /rest/v1/versions/draft/diff but without transferring the full change set.

GET/rest/v1/versions

Authorization

apiKey

AuthorizationBearer <token>

Ours Privacy API key

In: header

Query Parameters

limit?|

Maximum number of items to return. Defaults to 25; values below 1 are clamped to 1 and values above 100 are clamped to 100.

cursor?string

Opaque pagination cursor from pagination.nextCursor in the previous response. Do not decode or modify it. Malformed cursors return 400 Bad Request.

isPublished?|

Filter to only published or unpublished versions.

nameContains?string

Case-insensitive substring match on the version name.

notesContains?string

Case-insensitive substring match on the version notes.

Response Body

`application/json`

curl -X GET "https://example.com/rest/v1/versions"

{  "entities": [    {      "id": "string",      "name": "string",      "versionNumber": 0,      "isPublished": true,      "notes": "string",      "createdAt": "string",      "publishedAt": "string",      "publishedByUserId": "string",      "publishedByUserName": "string"    }  ],  "pagination": {    "nextCursor": "string",    "hasMore": true  }}

{  "error": "string",  "details": "string"}

{  "error": "string",  "details": "string"}

{  "error": "string",  "details": "string"}

{  "error": "string",  "details": "string"}

{  "error": "string",  "details": "string"}

POST/rest/v1/versions

Authorization

apiKey

AuthorizationBearer <token>

Ours Privacy API key

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

includeAllowedEvents?array<string>|

Cherry-pick: allowed event ids (slug-like strings) to include from the draft. Omit or send [] to include all draft changes in this collection.

includeConsentSettings?array<string>|

Cherry-pick: consent settings ids to include from the draft. Omit or send [] to include all draft changes in this collection.

includeDestinations?array<string>|

Cherry-pick: destination UUIDs to include from the draft. Omit or send [] to include all draft changes in this collection.

includeExternalAllowedEventData?array<string>|

Cherry-pick: external allowed event data ids to include from the draft. Omit or send [] to include all draft changes in this collection.

includeGlobalDispatchCenters?array<string>|

Cherry-pick: global dispatch center ids to include from the draft. Omit or send [] to include all draft changes in this collection.

includeMappings?array<string>|

Cherry-pick: mapping ids to include from the draft. Omit or send [] to include all draft changes in this collection.

includeReplaySettings?array<string>|

Cherry-pick: replay settings ids to include from the draft. Omit or send [] to include all draft changes in this collection.

includeSources?array<string>|

Cherry-pick: source UUIDs to include from the draft. Omit or send [] to include all draft changes in this collection.

includeTagManagerTags?array<string>|

Cherry-pick: tag manager tag UUIDs to include from the draft. Omit or send [] to include all draft changes in this collection.

includeTagManagerTriggers?array<string>|

Cherry-pick: tag manager trigger UUIDs to include from the draft. Omit or send [] to include all draft changes in this collection.

includeTagManagerVariables?array<string>|

Cherry-pick: tag manager variable UUIDs to include from the draft. Omit or send [] to include all draft changes in this collection.

includeDataGovernanceRules?array<string>|

Cherry-pick: data governance rule UUIDs to include from the draft. Omit or send [] to include all draft changes in this collection.

includeDataGovernanceEvents?array<string>|

Cherry-pick: data governance event UUIDs to include from the draft. Omit or send [] to include all draft changes in this collection.

includeExperimentSettings?array<string>|

Cherry-pick: experiment settings UUIDs to include from the draft. Omit or send [] to include all draft changes in this collection.

includeExperiments?array<string>|

Cherry-pick: experiment UUIDs to include from the draft. Omit or send [] to include all draft changes in this collection.

includeExperimentVariants?array<string>|

Cherry-pick: experiment variant UUIDs to include from the draft. Omit or send [] to include all draft changes in this collection.

name?string|null

notes?string|null

Response Body

`application/json`

curl -X POST "https://example.com/rest/v1/versions" \  -H "Content-Type: application/json" \  -d '{}'

{  "id": "string",  "name": "string",  "versionNumber": 0,  "isPublished": true,  "notes": "string",  "createdAt": "string",  "publishedAt": "string",  "publishedByUserId": "string",  "publishedByUserName": "string"}

{  "error": "string",  "details": "string"}

{  "error": "string",  "details": "string"}

{  "error": "string",  "details": "string"}

{  "error": "string",  "details": "string"}

{  "error": "string",  "details": "string"}

{  "error": "string",  "details": "string"}

GET/rest/v1/versions/{id}

Authorization

apiKey

AuthorizationBearer <token>

Ours Privacy API key

In: header

Path Parameters

id*string

Response Body

`application/json`

curl -X GET "https://example.com/rest/v1/versions/string"

{  "id": "string",  "name": "string",  "versionNumber": 0,  "isPublished": true,  "notes": "string",  "createdAt": "string",  "publishedAt": "string",  "publishedByUserId": "string",  "publishedByUserName": "string"}

{  "error": "string",  "details": "string"}

{  "error": "string",  "details": "string"}

{  "error": "string",  "details": "string"}

{  "error": "string",  "details": "string"}

{  "error": "string",  "details": "string"}

PATCH/rest/v1/versions/{id}

Authorization

apiKey

AuthorizationBearer <token>

Ours Privacy API key

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?string|null

notes?string|null

Response Body

`application/json`

curl -X PATCH "https://example.com/rest/v1/versions/string" \  -H "Content-Type: application/json" \  -d '{}'

{  "id": "string",  "name": "string",  "versionNumber": 0,  "isPublished": true,  "notes": "string",  "createdAt": "string",  "publishedAt": "string",  "publishedByUserId": "string",  "publishedByUserName": "string"}

{  "error": "string",  "details": "string"}

{  "error": "string",  "details": "string"}

{  "error": "string",  "details": "string"}

{  "error": "string",  "details": "string"}

{  "error": "string",  "details": "string"}

POST/rest/v1/versions/{id}/publish

Authorization

apiKey

AuthorizationBearer <token>

Ours Privacy API key

In: header

Path Parameters

id*string

Response Body

`application/json`

curl -X POST "https://example.com/rest/v1/versions/string/publish"

{  "id": "string",  "name": "string",  "versionNumber": 0,  "isPublished": true,  "notes": "string",  "createdAt": "string",  "publishedAt": "string",  "publishedByUserId": "string",  "publishedByUserName": "string"}

{  "error": "string",  "details": "string"}

{  "error": "string",  "details": "string"}

{  "error": "string",  "details": "string"}

{  "error": "string",  "details": "string"}

{  "error": "string",  "details": "string"}

{  "error": "string",  "details": "string"}

GET/rest/v1/versions/{id}/snapshot

Authorization

apiKey

AuthorizationBearer <token>

Ours Privacy API key

In: header

Path Parameters

id*string

Response Body

`application/json`

curl -X GET "https://example.com/rest/v1/versions/string/snapshot"

{  "id": "string",  "versionNumber": 0,  "jsonContent": {}}

{  "error": "string",  "details": "string"}

{  "error": "string",  "details": "string"}

{  "error": "string",  "details": "string"}

{  "error": "string",  "details": "string"}

{  "error": "string",  "details": "string"}

GET/rest/v1/versions/{id}/diff

Authorization

apiKey

AuthorizationBearer <token>

Ours Privacy API key

In: header

Path Parameters

id*|

Query Parameters

against?string

Baseline version id to compare the path version against. Omit for the latest published version. Pass a version UUID to compute a version-vs-version diff.

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/rest/v1/versions/draft/diff"

{  "count": 0,  "differences": {    "destinations": {      "added": [        {          "id": "string",          "name": "string",          "type": "string",          "summary": "string",          "tagManagerId": "string"        }      ],      "removed": [        {          "id": "string",          "name": "string",          "type": "string",          "summary": "string",          "tagManagerId": "string"        }      ],      "modified": [        {          "old": {            "id": "string",            "name": "string",            "type": "string",            "summary": "string",            "tagManagerId": "string"          },          "new": {            "id": "string",            "name": "string",            "type": "string",            "summary": "string",            "tagManagerId": "string"          }        }      ]    },    "sources": {      "added": [        {          "id": "string",          "name": "string",          "type": "string",          "summary": "string",          "tagManagerId": "string"        }      ],      "removed": [        {          "id": "string",          "name": "string",          "type": "string",          "summary": "string",          "tagManagerId": "string"        }      ],      "modified": [        {          "old": {            "id": "string",            "name": "string",            "type": "string",            "summary": "string",            "tagManagerId": "string"          },          "new": {            "id": "string",            "name": "string",            "type": "string",            "summary": "string",            "tagManagerId": "string"          }        }      ]    },    "allowedEvents": {      "added": [        {          "id": "string",          "name": "string",          "type": "string",          "summary": "string",          "tagManagerId": "string"        }      ],      "removed": [        {          "id": "string",          "name": "string",          "type": "string",          "summary": "string",          "tagManagerId": "string"        }      ],      "modified": [        {          "old": {            "id": "string",            "name": "string",            "type": "string",            "summary": "string",            "tagManagerId": "string"          },          "new": {            "id": "string",            "name": "string",            "type": "string",            "summary": "string",            "tagManagerId": "string"          }        }      ]    },    "externalAllowedEventData": {      "added": [        {          "id": "string",          "name": "string",          "type": "string",          "summary": "string",          "tagManagerId": "string"        }      ],      "removed": [        {          "id": "string",          "name": "string",          "type": "string",          "summary": "string",          "tagManagerId": "string"        }      ],      "modified": [        {          "old": {            "id": "string",            "name": "string",            "type": "string",            "summary": "string",            "tagManagerId": "string"          },          "new": {            "id": "string",            "name": "string",            "type": "string",            "summary": "string",            "tagManagerId": "string"          }        }      ]    },    "mappings": {      "added": [        {          "id": "string",          "name": "string",          "type": "string",          "summary": "string",          "tagManagerId": "string"        }      ],      "removed": [        {          "id": "string",          "name": "string",          "type": "string",          "summary": "string",          "tagManagerId": "string"        }      ],      "modified": [        {          "old": {            "id": "string",            "name": "string",            "type": "string",            "summary": "string",            "tagManagerId": "string"          },          "new": {            "id": "string",            "name": "string",            "type": "string",            "summary": "string",            "tagManagerId": "string"          }        }      ]    },    "consentSettings": {      "added": [        {          "id": "string",          "name": "string",          "type": "string",          "summary": "string",          "tagManagerId": "string"        }      ],      "removed": [        {          "id": "string",          "name": "string",          "type": "string",          "summary": "string",          "tagManagerId": "string"        }      ],      "modified": [        {          "old": {            "id": "string",            "name": "string",            "type": "string",            "summary": "string",            "tagManagerId": "string"          },          "new": {            "id": "string",            "name": "string",            "type": "string",            "summary": "string",            "tagManagerId": "string"          }        }      ]    },    "globalDispatchCenters": {      "added": [        {          "id": "string",          "name": "string",          "type": "string",          "summary": "string",          "tagManagerId": "string"        }      ],      "removed": [        {          "id": "string",          "name": "string",          "type": "string",          "summary": "string",          "tagManagerId": "string"        }      ],      "modified": [        {          "old": {            "id": "string",            "name": "string",            "type": "string",            "summary": "string",            "tagManagerId": "string"          },          "new": {            "id": "string",            "name": "string",            "type": "string",            "summary": "string",            "tagManagerId": "string"          }        }      ]    },    "replaySettings": {      "added": [        {          "id": "string",          "name": "string",          "type": "string",          "summary": "string",          "tagManagerId": "string"        }      ],      "removed": [        {          "id": "string",          "name": "string",          "type": "string",          "summary": "string",          "tagManagerId": "string"        }      ],      "modified": [        {          "old": {            "id": "string",            "name": "string",            "type": "string",            "summary": "string",            "tagManagerId": "string"          },          "new": {            "id": "string",            "name": "string",            "type": "string",            "summary": "string",            "tagManagerId": "string"          }        }      ]    },    "tagManagers": {      "added": [        {          "id": "string",          "name": "string",          "type": "string",          "summary": "string",          "tagManagerId": "string"        }      ],      "removed": [        {          "id": "string",          "name": "string",          "type": "string",          "summary": "string",          "tagManagerId": "string"        }      ],      "modified": [        {          "old": {            "id": "string",            "name": "string",            "type": "string",            "summary": "string",            "tagManagerId": "string"          },          "new": {            "id": "string",            "name": "string",            "type": "string",            "summary": "string",            "tagManagerId": "string"          }        }      ]    },    "tagManagerTags": {      "added": [        {          "id": "string",          "name": "string",          "type": "string",          "summary": "string",          "tagManagerId": "string"        }      ],      "removed": [        {          "id": "string",          "name": "string",          "type": "string",          "summary": "string",          "tagManagerId": "string"        }      ],      "modified": [        {          "old": {            "id": "string",            "name": "string",            "type": "string",            "summary": "string",            "tagManagerId": "string"          },          "new": {            "id": "string",            "name": "string",            "type": "string",            "summary": "string",            "tagManagerId": "string"          }        }      ]    },    "tagManagerTriggers": {      "added": [        {          "id": "string",          "name": "string",          "type": "string",          "summary": "string",          "tagManagerId": "string"        }      ],      "removed": [        {          "id": "string",          "name": "string",          "type": "string",          "summary": "string",          "tagManagerId": "string"        }      ],      "modified": [        {          "old": {            "id": "string",            "name": "string",            "type": "string",            "summary": "string",            "tagManagerId": "string"          },          "new": {            "id": "string",            "name": "string",            "type": "string",            "summary": "string",            "tagManagerId": "string"          }        }      ]    },    "tagManagerVariables": {      "added": [        {          "id": "string",          "name": "string",          "type": "string",          "summary": "string",          "tagManagerId": "string"        }      ],      "removed": [        {          "id": "string",          "name": "string",          "type": "string",          "summary": "string",          "tagManagerId": "string"        }      ],      "modified": [        {          "old": {            "id": "string",            "name": "string",            "type": "string",            "summary": "string",            "tagManagerId": "string"          },          "new": {            "id": "string",            "name": "string",            "type": "string",            "summary": "string",            "tagManagerId": "string"          }        }      ]    },    "dataGovernanceRules": {      "added": [        {          "id": "string",          "name": "string",          "type": "string",          "summary": "string",          "tagManagerId": "string"        }      ],      "removed": [        {          "id": "string",          "name": "string",          "type": "string",          "summary": "string",          "tagManagerId": "string"        }      ],      "modified": [        {          "old": {            "id": "string",            "name": "string",            "type": "string",            "summary": "string",            "tagManagerId": "string"          },          "new": {            "id": "string",            "name": "string",            "type": "string",            "summary": "string",            "tagManagerId": "string"          }        }      ]    },    "dataGovernanceEvents": {      "added": [        {          "id": "string",          "name": "string",          "type": "string",          "summary": "string",          "tagManagerId": "string"        }      ],      "removed": [        {          "id": "string",          "name": "string",          "type": "string",          "summary": "string",          "tagManagerId": "string"        }      ],      "modified": [        {          "old": {            "id": "string",            "name": "string",            "type": "string",            "summary": "string",            "tagManagerId": "string"          },          "new": {            "id": "string",            "name": "string",            "type": "string",            "summary": "string",            "tagManagerId": "string"          }        }      ]    },    "experimentSettings": {      "added": [        {          "id": "string",          "name": "string",          "type": "string",          "summary": "string",          "tagManagerId": "string"        }      ],      "removed": [        {          "id": "string",          "name": "string",          "type": "string",          "summary": "string",          "tagManagerId": "string"        }      ],      "modified": [        {          "old": {            "id": "string",            "name": "string",            "type": "string",            "summary": "string",            "tagManagerId": "string"          },          "new": {            "id": "string",            "name": "string",            "type": "string",            "summary": "string",            "tagManagerId": "string"          }        }      ]    },    "experiments": {      "added": [        {          "id": "string",          "name": "string",          "type": "string",          "summary": "string",          "tagManagerId": "string"        }      ],      "removed": [        {          "id": "string",          "name": "string",          "type": "string",          "summary": "string",          "tagManagerId": "string"        }      ],      "modified": [        {          "old": {            "id": "string",            "name": "string",            "type": "string",            "summary": "string",            "tagManagerId": "string"          },          "new": {            "id": "string",            "name": "string",            "type": "string",            "summary": "string",            "tagManagerId": "string"          }        }      ]    },    "experimentVariants": {      "added": [        {          "id": "string",          "name": "string",          "type": "string",          "summary": "string",          "tagManagerId": "string"        }      ],      "removed": [        {          "id": "string",          "name": "string",          "type": "string",          "summary": "string",          "tagManagerId": "string"        }      ],      "modified": [        {          "old": {            "id": "string",            "name": "string",            "type": "string",            "summary": "string",            "tagManagerId": "string"          },          "new": {            "id": "string",            "name": "string",            "type": "string",            "summary": "string",            "tagManagerId": "string"          }        }      ]    }  }}

{  "error": "string",  "details": "string"}

{  "error": "string",  "details": "string"}

{  "error": "string",  "details": "string"}

{  "error": "string",  "details": "string"}

{  "error": "string",  "details": "string"}

GET/rest/v1/versions/{id}/status

Authorization

apiKey

AuthorizationBearer <token>

Ours Privacy API key

In: header

Path Parameters

id*"draft"

Value in

"draft"

Query Parameters

collection*string

Entity collection the id belongs to. experiments and experimentVariants are not supported — draft experiments never snapshot into a version — but experimentSettings is.

Value in

"allowedEvents"
"consentSettings"
"dataGovernanceEvents"
"dataGovernanceRules"
"destinations"
"experimentSettings"
"externalAllowedEventData"
"globalDispatchCenters"
"mappings"
"replaySettings"
"sources"
"tagManagerTags"
"tagManagerTriggers"
"tagManagerVariables"
"tagManagers"

entityId*string

Id of the entity to check. Most collections use UUIDs; allowedEvents, externalAllowedEventData, mappings, consentSettings, globalDispatchCenters, and replaySettings use slug-like strings.

Length1 <= length

Response Body

`application/json`

curl -X GET "https://example.com/rest/v1/versions/draft/status?collection=allowedEvents&entityId=string"

{  "collection": "allowedEvents",  "id": "string",  "status": "added"}

{  "error": "string",  "details": "string"}

{  "error": "string",  "details": "string"}

{  "error": "string",  "details": "string"}

{  "error": "string",  "details": "string"}

{  "error": "string",  "details": "string"}

POST/rest/v1/versions/{id}/revert

Authorization

apiKey

AuthorizationBearer <token>

Ours Privacy API key

In: header

Path Parameters

id*"draft"

Value in

"draft"

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

entities*array<>

Draft entities to revert back to the latest published version. Each entry is processed independently: a modified entity is restored to its published values, a deleted entity is recreated, and a newly-added entity is discarded. Pass a single entry to revert one change.

Response Body

`application/json`

curl -X POST "https://example.com/rest/v1/versions/draft/revert" \  -H "Content-Type: application/json" \  -d '{    "entities": [      {        "collection": "allowedEvents",        "id": "string"      }    ]  }'

{  "revertedCount": 0,  "restoredCount": 0,  "discardedCount": 0,  "notFoundCount": 0,  "remainingChanges": 0}

{  "error": "string",  "details": "string"}

{  "error": "string",  "details": "string"}

{  "error": "string",  "details": "string"}

{  "error": "string",  "details": "string"}

{  "error": "string",  "details": "string"}

POST/rest/v1/versions/{id}/abandon

Authorization

apiKey

AuthorizationBearer <token>

Ours Privacy API key

In: header

Path Parameters

id*"draft"

Value in

"draft"

Response Body

`application/json`

curl -X POST "https://example.com/rest/v1/versions/draft/abandon"

{  "revertedCount": 0,  "restoredCount": 0,  "discardedCount": 0,  "notFoundCount": 0,  "remainingChanges": 0}

{  "error": "string",  "details": "string"}

{  "error": "string",  "details": "string"}

{  "error": "string",  "details": "string"}

{  "error": "string",  "details": "string"}

{  "error": "string",  "details": "string"}

{  "error": "string",  "details": "string"}

Versions

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`