Audit
Analytics
Content
Content - attachments
Content body
Content - children and descendants
Content - macro body
Content comments
Content labels
Content permissions
Content properties
Content restrictions
Content states
Content versions
Content watches
Dynamic modules
Experimental
Group
Inline tasks
Label info
Long-running task
Relation
Search
Settings
Space
Space permissions
Space properties
Space settings
Template
Themes
Users

Rate this page:

Space settings

Get space settings

GET /wiki/rest/api/space/{spaceKey}/settings

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

OAuth 2.0 scopes required:
ClassicRECOMMENDED:read:confluence-space.summary
Granular:read:space.setting:confluence

Request

Path parameters
spaceKey Required

string

The key of the space to be queried for its settings.

Example

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}/settings`, {
  headers: {
    'Accept': 'application/json'
  }
});

console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());

Responses

Returned if the space settings are returned.

Content typeValueRestrictions
application/json

SpaceSettings

Nullable: true

Update space settings

PUT /wiki/rest/api/space/{spaceKey}/settings

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

OAuth 2.0 scopes required:
ClassicRECOMMENDED:write:confluence-space
Granular:read:space.setting:confluence, write:space.setting:confluence

Request

Path parameters
spaceKey Required

string

The key of the space whose settings will be updated.

Body parameters
routeOverrideEnabled

boolean

Defines whether an override for the space home should be used. This is used in conjunction with a space theme provided by an app. For example, if this property is set to true, a theme can display a page other than the space homepage when users visit the root URL for a space. This property allows apps to provide content-only theming without overriding the space home.

Example

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 = `{
  "routeOverrideEnabled": true
}`;

const response = await api.asApp().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());

Responses

Returned if space settings are updated.

Content typeValueRestrictions
application/json

SpaceSettings

Nullable: true

Rate this page: