Returns all themes, not including the default theme.
Permissions required: None
Connect app scope required: READ
manage:confluence-configurationread:configuration:confluenceinteger
integer
Returned if the requested themes are returned.
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/rest/api/settings/theme`, {
headers: {
'Accept': 'application/json'
}
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
{
"results": [
{
"themeKey": "<string>",
"name": "<string>",
"description": "<string>",
"icon": {
"path": "<string>",
"width": 2154,
"height": 2154,
"isDefault": true
}
}
],
"start": 2154,
"limit": 2154,
"size": 2154,
"_links": {}
}Returns the globally assigned theme.
Permissions required: None
Connect app scope required: READ
manage:confluence-configurationread:configuration:confluenceThis request has no parameters.
Returned if the global theme is returned.
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/rest/api/settings/theme/selected`, {
headers: {
'Accept': 'application/json'
}
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());1
2
3
4
5
6
7
8
9
10
11
12
{
"themeKey": "<string>",
"name": "<string>",
"description": "<string>",
"icon": {
"path": "<string>",
"width": 2154,
"height": 2154,
"isDefault": true
},
"_links": {}
}Returns a theme. This includes information about the theme name, description, and icon.
Permissions required: None
Connect app scope required: READ
manage:confluence-configurationread:configuration:confluencestring
RequiredReturned if the requested theme is returned.
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/rest/api/settings/theme/{themeKey}`, {
headers: {
'Accept': 'application/json'
}
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());1
2
3
4
5
6
7
8
9
10
11
12
{
"themeKey": "<string>",
"name": "<string>",
"description": "<string>",
"icon": {
"path": "<string>",
"width": 2154,
"height": 2154,
"isDefault": true
},
"_links": {}
}Returns the theme selected for a space, if one is set. If no space theme is set, this means that the space is inheriting the global look and feel settings.
Permissions required: ‘View’ permission for the space.
Connect app scope required: READ
read:confluence-space.summaryread:space.setting:confluencestring
RequiredReturned if the requested theme is returned.
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/rest/api/space/{spaceKey}/theme`, {
headers: {
'Accept': 'application/json'
}
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());1
2
3
4
5
6
7
8
9
10
11
12
{
"themeKey": "<string>",
"name": "<string>",
"description": "<string>",
"icon": {
"path": "<string>",
"width": 2154,
"height": 2154,
"isDefault": true
},
"_links": {}
}Sets the theme for a space. Note, if you want to reset the space theme to the default Confluence theme, use the 'Reset space theme' method instead of this method.
Permissions required: 'Admin' permission for the space.
Connect app scope required: WRITE
write:confluence-spaceread:space.setting:confluence, write:space.setting:confluencestring
Requiredstring
RequiredReturned if the theme was set for the space.
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 = `{
"themeKey": "<string>"
}`;
const response = await api.asUser().requestConfluence(route`/wiki/rest/api/space/{spaceKey}/theme`, {
method: 'PUT',
headers: {
'Accept': 'application/json',
'Content-Type': 'application/json'
},
body: bodyData
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());1
2
3
4
5
6
7
8
9
10
11
12
{
"themeKey": "<string>",
"name": "<string>",
"description": "<string>",
"icon": {
"path": "<string>",
"width": 2154,
"height": 2154,
"isDefault": true
},
"_links": {}
}Resets the space theme. This means that the space will inherit the global look and feel settings
Permissions required: 'Admin' permission for the space.
Connect app scope required: DELETE
write:confluence-spacewrite:space.setting:confluencestring
RequiredReturned if the theme was reset for the space.
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/rest/api/space/{spaceKey}/theme`, {
method: 'DELETE'
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.text());Rate this page: