0

Get space settings

by
Published Oct 17, 2025

Returns the settings of a space. Currently only the `routeOverrideEnabled` setting can be returned. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space.

Script confluence Verified

The script

Submitted by hugo697 Bun
Verified 235 days ago
1
//native
2
type Confluence = {
3
	email: string
4
	apiToken: string
5
	domain: string
6
}
7
/**
8
 * Get space settings
9
 * Returns the settings of a space. Currently only the
10
`routeOverrideEnabled` setting can be returned.
11

12
**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
13
'View' permission for the space.
14
 */
15
export async function main(auth: Confluence, spaceKey: string) {
16
	const url = new URL(`https://${auth.domain}/wiki/rest/api/space/${spaceKey}/settings`)
17

18
	const response = await fetch(url, {
19
		method: 'GET',
20
		headers: {
21
			Authorization: 'Basic ' + btoa(`${auth.email}:${auth.apiToken}`)
22
		},
23
		body: undefined
24
	})
25
	if (!response.ok) {
26
		const text = await response.text()
27
		throw new Error(`${response.status} ${text}`)
28
	}
29
	return await response.json()
30
}
31