Returns the settings of a space. Currently only the
routeOverrideEnabled setting can be returned.
Permissions required: 'View' permission for the space.
Connect app scope required: READ
read:confluence-space.summaryread:space.setting:confluencestring
RequiredReturned if the space settings are returned.
true1
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}/settings`, {
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
{
"routeOverrideEnabled": true,
"editor": {
"page": "<string>",
"blogpost": "<string>",
"default": "<string>"
},
"spaceKey": "<string>",
"_links": {}
}Updates the settings for a space. Currently only the
routeOverrideEnabled setting can be updated.
Permissions required: 'Admin' permission for the space.
Connect app scope required: WRITE
write:confluence-spaceread:space.setting:confluence, write:space.setting:confluencestring
RequiredThe space settings to update.
boolean
Returned if space settings are updated.
true1
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 = `{
"routeOverrideEnabled": true
}`;
const response = await api.asUser().requestConfluence(route`/wiki/rest/api/space/{spaceKey}/settings`, {
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
{
"routeOverrideEnabled": true,
"editor": {
"page": "<string>",
"blogpost": "<string>",
"default": "<string>"
},
"spaceKey": "<string>",
"_links": {}
}Rate this page: