Rate this page:
GET /wiki/rest/api/settings/theme
Returns all themes, not including the default theme.
Permissions required: None
Connect app scope required: READ
manage:confluence-configurationread:configuration:confluenceinteger
The starting index of the returned themes.
0, Minimum: 0, Format: int32integer
The maximum number of themes to return per page. Note, this may be restricted by fixed system limits.
100, Minimum: 0, Format: int321 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.asApp().requestConfluence(route`/wiki/rest/api/settings/theme`, {
headers: {
'Accept': 'application/json'
}
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());Returned if the requested themes are returned.
| Content type | Value |
|---|---|
| application/json |
GET /wiki/rest/api/settings/theme/selected
Returns the globally assigned theme.
Permissions required: None
Connect app scope required: READ
manage:confluence-configurationread:configuration:confluence1 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.asApp().requestConfluence(route`/wiki/rest/api/settings/theme/selected`, {
headers: {
'Accept': 'application/json'
}
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());Returned if the global theme is returned.
| Content type | Value |
|---|---|
| application/json |
GET /wiki/rest/api/settings/theme/{themeKey}
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
The key of the theme to be 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.asApp().requestConfluence(route`/wiki/rest/api/settings/theme/{themeKey}`, {
headers: {
'Accept': 'application/json'
}
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());Returned if the requested theme is returned.
| Content type | Value |
|---|---|
| application/json |
GET /wiki/rest/api/space/{spaceKey}/theme
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
The key of the space to be queried for its theme.
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.asApp().requestConfluence(route`/wiki/rest/api/space/{spaceKey}/theme`, {
headers: {
'Accept': 'application/json'
}
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());Returned if the requested theme is returned.
| Content type | Value |
|---|---|
| application/json |
PUT /wiki/rest/api/space/{spaceKey}/theme
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
The key of the space to set the theme for.
string
The key of the theme to be set as the space theme.
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.asApp().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());Returned if the theme was set for the space.
| Content type | Value |
|---|---|
| application/json |
DELETE /wiki/rest/api/space/{spaceKey}/theme
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
The key of the space to reset the theme for.
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.asApp().requestConfluence(route`/wiki/rest/api/space/{spaceKey}/theme`, {
method: 'DELETE'
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.text());Returned if the theme was reset for the space.
A schema has not been defined for this response code.
Rate this page: