Rate this page:
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.
App scope required: READ
read:confluence-space.summarystring
The key of the space to be queried for its settings.
1 2 3
curl --request GET \
--url 'https://your-domain.atlassian.net/wiki/rest/api/space/{spaceKey}/settings' \
--header 'Accept: application/json'Returned if the space settings are returned.
| Content type | Value |
|---|---|
| application/json |
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.
App scope required: WRITE
write:confluence-spacestring
The key of the space whose settings will be updated.
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.
1 2 3 4 5 6 7
curl --request PUT \
--url 'https://your-domain.atlassian.net/wiki/rest/api/space/{spaceKey}/settings' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"routeOverrideEnabled": true
}'Returned if space settings are updated.
| Content type | Value |
|---|---|
| application/json |
Rate this page: