Cloud
Confluence Cloud / Reference / REST API v2
GET

Get data policy metadata for the workspaceExperimental

Returns data policy metadata for the workspace.

Permissions required: Only apps can make this request. Permission to access the Confluence site ('Can use' global permission).

Data Security Policy: Exempt from app access rules
Scopes
read:configuration:confluence

Connect app scope requiredREAD

Request

This request has no parameters.

Responses

Returned if the request is successful.

application/json

DataPolicyMetadata

Details about data policies.

GET/data-policies/metadata
1 2 3 4 5 6 7 8 9 10 11 12 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import api, { route } from "@forge/api"; const response = await api.asUser().requestConfluence(route`/wiki/api/v2/data-policies/metadata`, { headers: { 'Accept': 'application/json' } }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.json());
200Response
1 2 3 { "anyContentBlocked": true }
GET

Get spaces with data policiesExperimental

Returns all spaces. The results will be sorted by id ascending. The number of results is limited by the limit parameter and additional results (if available) will be available through the next URL present in the Link response header.

Permissions required: Only apps can make this request. Permission to access the Confluence site ('Can use' global permission). Only spaces that the app has permission to view will be returned.

Data Security Policy: Exempt from app access rules
Scopes
read:space:confluence

Connect app scope requiredREAD

Request

Query parameters

ids

array<integer>

keys

array<string>

sort

SpaceSortOrder

cursor

string

limit

integer

Responses

Returned if the requested spaces are returned.

Headers

Link

string

application/json

MultiEntityResult<DataPolicySpace>
GET/data-policies/spaces
1 2 3 4 5 6 7 8 9 10 11 12 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import api, { route } from "@forge/api"; const response = await api.asUser().requestConfluence(route`/wiki/api/v2/data-policies/spaces`, { headers: { 'Accept': 'application/json' } }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.json());
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 { "results": [ { "id": "<string>", "key": "<string>", "name": "<string>", "description": { "plain": {}, "view": {} }, "dataPolicy": { "anyContentBlocked": true }, "icon": { "path": "<string>", "apiDownloadLink": "<string>" }, "_links": { "webui": "<string>" } } ], "_links": { "next": "<string>", "base": "<string>" } }

Rate this page: