GET

Get list of classification levels

Returns a list of classification levels available.

Permissions required: 'Permission to access the Confluence site ('Can use' global permission).

Scopes
read:configuration:confluence

Connect app scope requiredREAD

Request

This request has no parameters.

Responses

Returned if classifications levels are returned.

application/json

array<ClassificationLevel>

GET/classification-levels
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/classification-levels`, { 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 [ { "id": "<string>", "status": "DRAFT", "order": 45, "name": "<string>", "description": "<string>", "guideline": "<string>", "color": "RED" } ]
GET

Get space default classification level

Returns the default classification level for a specific space.

Permissions required: 'Permission to access the Confluence site ('Can use' global permission) and permission to view the space.

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

Connect app scope requiredREAD

Request

Path parameters

id

integer

Required

Responses

Returned if the requested default classification level for a space is returned.

application/json

ClassificationLevel

A unit of data classification defined by an organiation. A classification level may be associated with specific storage and handling requirements or expectations.

GET/spaces/{id}/classification-level/default
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/spaces/{id}/classification-level/default`, { 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 { "id": "<string>", "status": "DRAFT", "order": 45, "name": "<string>", "description": "<string>", "guideline": "<string>", "color": "RED" }
PUT

Update space default classification level

Update the default classification level for a specific space.

Permissions required: 'Permission to access the Confluence site ('Can use' global permission) and 'Admin' permission for the space.

Data Security Policy: Not exempt from app access rules
Scopes
read:space:confluence, write:space:confluence

Connect app scope requiredWRITE

Request

Path parameters

id

integer

Required

Request bodyapplication/json

id

string

Required
status

string

Required

Responses

Returned if the default classification level was successfully updated.

PUT/spaces/{id}/classification-level/default
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import api, { route } from "@forge/api"; var bodyData = `{ "id": "<string>", "status": "current" }`; const response = await api.asUser().requestConfluence(route`/wiki/api/v2/spaces/{id}/classification-level/default`, { method: 'PUT', headers: { 'Content-Type': 'application/json' }, body: bodyData }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.text());
DEL

Delete space default classification level

Returns the default classification level for a specific space.

Permissions required: 'Permission to access the Confluence site ('Can use' global permission) and 'Admin' permission for the space.

Data Security Policy: Not exempt from app access rules
Scopes
read:space:confluence, write:space:confluence

Connect app scope requiredWRITE

Request

Path parameters

id

integer

Required

Responses

Returned if the default classification level was successfully deleted.

DEL/spaces/{id}/classification-level/default
1 2 3 4 5 6 7 8 9 10 // 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/spaces/{id}/classification-level/default`, { method: 'DELETE' }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.text());
GET

Get page classification level

Returns the classification level for a specific page.

Permissions required: 'Permission to access the Confluence site ('Can use' global permission) and permission to view the page. 'Permission to edit the page is required if trying to view classification level for a draft.

Data Security Policy: Not exempt from app access rules
Scopes
read:page:confluence, write:page:confluence

Connect app scope requiredWRITE

Request

Path parameters

id

integer

Required

Query parameters

status

string

Responses

Returned if the requested classification level for a page is returned.

application/json

ClassificationLevel

A unit of data classification defined by an organiation. A classification level may be associated with specific storage and handling requirements or expectations.

GET/pages/{id}/classification-level
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/pages/{id}/classification-level`, { 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 { "id": "<string>", "status": "DRAFT", "order": 45, "name": "<string>", "description": "<string>", "guideline": "<string>", "color": "RED" }
PUT

Update page classification level

Updates the classification level for a specific page.

Permissions required: 'Permission to access the Confluence site ('Can use' global permission) and permission to edit the page.

Data Security Policy: Not exempt from app access rules
Scopes
write:page:confluence

Connect app scope requiredWRITE

Request

Path parameters

id

integer

Required

Request bodyapplication/json

id

string

Required
status

string

Required

Responses

Returned if the classification level was successfully updated.

PUT/pages/{id}/classification-level
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import api, { route } from "@forge/api"; var bodyData = `{ "id": "<string>", "status": "current" }`; const response = await api.asUser().requestConfluence(route`/wiki/api/v2/pages/{id}/classification-level`, { method: 'PUT', headers: { 'Content-Type': 'application/json' }, body: bodyData }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.text());
POST

Reset page classification level

Resets the classification level for a specific page for the space default classification level.

Permissions required: 'Permission to access the Confluence site ('Can use' global permission) and permission to view the page.

Data Security Policy: Not exempt from app access rules
Scopes
write:page:confluence

Connect app scope requiredWRITE

Request

Path parameters

id

integer

Required

Request bodyapplication/json

status

string

Required

Responses

Returned if the classification level was successfully reset.

POST/pages/{id}/classification-level/reset
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import api, { route } from "@forge/api"; var bodyData = `{ "status": "current" }`; const response = await api.asUser().requestConfluence(route`/wiki/api/v2/pages/{id}/classification-level/reset`, { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: bodyData }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.text());
GET

Get blog post classification level

Returns the classification level for a specific blog post.

Permissions required: 'Permission to access the Confluence site ('Can use' global permission) and permission to view the blog post. 'Permission to edit the blog post is required if trying to view classification level for a draft.

Data Security Policy: Not exempt from app access rules
Scopes
read:page:confluence, write:page:confluence

Connect app scope requiredWRITE

Request

Path parameters

id

integer

Required

Query parameters

status

string

Responses

Returned if the requested classification level for a blog post is returned.

application/json

ClassificationLevel

A unit of data classification defined by an organiation. A classification level may be associated with specific storage and handling requirements or expectations.

GET/blogposts/{id}/classification-level
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/blogposts/{id}/classification-level`, { 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 { "id": "<string>", "status": "DRAFT", "order": 45, "name": "<string>", "description": "<string>", "guideline": "<string>", "color": "RED" }
PUT

Update blog post classification level

Updates the classification level for a specific blog post.

Permissions required: 'Permission to access the Confluence site ('Can use' global permission) and permission to edit the blog post.

Data Security Policy: Not exempt from app access rules
Scopes
write:page:confluence

Connect app scope requiredWRITE

Request

Path parameters

id

integer

Required

Request bodyapplication/json

id

string

Required
status

string

Required

Responses

Returned if the classification level was successfully updated.

PUT/blogposts/{id}/classification-level
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import api, { route } from "@forge/api"; var bodyData = `{ "id": "<string>", "status": "current" }`; const response = await api.asUser().requestConfluence(route`/wiki/api/v2/blogposts/{id}/classification-level`, { method: 'PUT', headers: { 'Content-Type': 'application/json' }, body: bodyData }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.text());
POST

Reset blog post classification level

Resets the classification level for a specific blog post for the space
default classification level.

Permissions required: 'Permission to access the Confluence site ('Can use' global permission) and permission to view the blog post.

Data Security Policy: Not exempt from app access rules
Scopes
write:page:confluence

Connect app scope requiredWRITE

Request

Path parameters

id

integer

Required

Request bodyapplication/json

status

string

Required

Responses

Returned if the classification level was successfully reset.

POST/blogposts/{id}/classification-level/reset
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import api, { route } from "@forge/api"; var bodyData = `{ "status": "current" }`; const response = await api.asUser().requestConfluence(route`/wiki/api/v2/blogposts/{id}/classification-level/reset`, { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: bodyData }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.text());
GET

Get whiteboard classification level

Returns the classification level for a specific whiteboard.

Permissions required: 'Permission to access the Confluence site ('Can use' global permission) and permission to view the whiteboard.

Data Security Policy: Not exempt from app access rules
Scopes
read:whiteboard:confluence

Connect app scope requiredREAD

Request

Path parameters

id

integer

Required

Responses

Returned if the requested classification level for a whiteboard is returned.

application/json

ClassificationLevel

A unit of data classification defined by an organiation. A classification level may be associated with specific storage and handling requirements or expectations.

GET/whiteboards/{id}/classification-level
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/whiteboards/{id}/classification-level`, { 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 { "id": "<string>", "status": "DRAFT", "order": 45, "name": "<string>", "description": "<string>", "guideline": "<string>", "color": "RED" }
PUT

Update whiteboard classification level

Updates the classification level for a specific whiteboard.

Permissions required: 'Permission to access the Confluence site ('Can use' global permission) and permission to edit the whiteboard.

Data Security Policy: Not exempt from app access rules
Scopes
write:whiteboard:confluence

Connect app scope requiredWRITE

Request

Path parameters

id

integer

Required

Request bodyapplication/json

id

string

Required
status

string

Required

Responses

Returned if the classification level was successfully updated.

PUT/whiteboards/{id}/classification-level
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import api, { route } from "@forge/api"; var bodyData = `{ "id": "<string>", "status": "current" }`; const response = await api.asUser().requestConfluence(route`/wiki/api/v2/whiteboards/{id}/classification-level`, { method: 'PUT', headers: { 'Content-Type': 'application/json' }, body: bodyData }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.text());
POST

Reset whiteboard classification level

Resets the classification level for a specific whiteboard for the space default classification level.

Permissions required: 'Permission to access the Confluence site ('Can use' global permission) and permission to view the whiteboard.

Data Security Policy: Not exempt from app access rules
Scopes
write:whiteboard:confluence

Connect app scope requiredWRITE

Request

Path parameters

id

integer

Required

Request bodyapplication/json

status

string

Required

Responses

Returned if the classification level was successfully reset.

POST/whiteboards/{id}/classification-level/reset
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import api, { route } from "@forge/api"; var bodyData = `{ "status": "current" }`; const response = await api.asUser().requestConfluence(route`/wiki/api/v2/whiteboards/{id}/classification-level/reset`, { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: bodyData }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.text());
GET

Get database classification level

Returns the classification level for a specific database.

Permissions required: 'Permission to access the Confluence site ('Can use' global permission) and permission to view the database.

Data Security Policy: Not exempt from app access rules
Scopes
read:database:confluence

Connect app scope requiredREAD

Request

Path parameters

id

integer

Required

Responses

Returned if the requested classification level for a database is returned.

application/json

ClassificationLevel

A unit of data classification defined by an organiation. A classification level may be associated with specific storage and handling requirements or expectations.

GET/databases/{id}/classification-level
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/databases/{id}/classification-level`, { 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 { "id": "<string>", "status": "DRAFT", "order": 45, "name": "<string>", "description": "<string>", "guideline": "<string>", "color": "RED" }
PUT

Update database classification level

Updates the classification level for a specific database.

Permissions required: 'Permission to access the Confluence site ('Can use' global permission) and permission to edit the database.

Data Security Policy: Not exempt from app access rules
Scopes
write:database:confluence

Connect app scope requiredWRITE

Request

Path parameters

id

integer

Required

Request bodyapplication/json

id

string

Required
status

string

Required

Responses

Returned if the classification level was successfully updated.

PUT/databases/{id}/classification-level
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import api, { route } from "@forge/api"; var bodyData = `{ "id": "<string>", "status": "current" }`; const response = await api.asUser().requestConfluence(route`/wiki/api/v2/databases/{id}/classification-level`, { method: 'PUT', headers: { 'Content-Type': 'application/json' }, body: bodyData }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.text());
POST

Reset database classification level

Resets the classification level for a specific database for the space default classification level.

Permissions required: 'Permission to access the Confluence site ('Can use' global permission) and permission to view the database.

Data Security Policy: Not exempt from app access rules
Scopes
write:database:confluence

Connect app scope requiredWRITE

Request

Path parameters

id

integer

Required

Request bodyapplication/json

status

string

Required

Responses

Returned if the classification level was successfully reset.

POST/databases/{id}/classification-level/reset
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import api, { route } from "@forge/api"; var bodyData = `{ "status": "current" }`; const response = await api.asUser().requestConfluence(route`/wiki/api/v2/databases/{id}/classification-level/reset`, { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: bodyData }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.text());

Rate this page: