Confluence Cloud Developer

Confluence Cloud Developer

Rate this page:

Settings

Get look and feel settings

GET /wiki/rest/api/settings/lookandfeel

Returns the look and feel settings for the site or a single space. This includes attributes such as the color scheme, padding, and border radius.

The look and feel settings for a space can be inherited from the global look and feel settings or provided by a theme.

Permissions required: None

App scope requiredREAD

OAuth scopes required
manage:confluence-configuration

Request

Query parameters
spaceKey

string

The key of the space for which the look and feel settings will be returned. If this is not set, only the global look and feel settings are returned.

Example

1
2
3
curl --request GET \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/settings/lookandfeel' \
  --header 'Accept: application/json'

Responses

Returned if the requested look and feel settings are returned.

Content typeValue
application/json

LookAndFeelSettings

Update look and feel settings

POST /wiki/rest/api/settings/lookandfeel/custom

Updates the look and feel settings for the site or for a single space. If custom settings exist, they are updated. If no custom settings exist, then a set of custom settings is created.

Note, if a theme is selected for a space, the space look and feel settings are provided by the theme and cannot be overridden.

Permissions required: 'Admin' permission for the space.

App scope requiredWRITE

OAuth scopes required
manage:confluence-configuration

Request

Query parameters
spaceKey

string

The key of the space for which the look and feel settings will be updated. If this is not set, the global look and feel settings will be updated.

Body parameters
headings Required

object

links Required

object

menus Required

MenusLookAndFeel

header Required

HeaderLookAndFeel

content Required

ContentLookAndFeel

bordersAndDividers Required

object

Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
curl --request POST \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/settings/lookandfeel/custom' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "headings": {
    "color": "<string>"
  },
  "links": {
    "color": "<string>"
  },
  "menus": {
    "hoverOrFocus": {
      "backgroundColor": "<string>"
    },
    "color": "<string>"
  },
  "header": {
    "backgroundColor": "<string>",
    "button": {
      "backgroundColor": "<string>",
      "color": "<string>"
    },
    "primaryNavigation": {
      "color": "<string>",
      "hoverOrFocus": {
        "backgroundColor": "<string>",
        "color": "<string>"
      }
    },
    "secondaryNavigation": {
      "color": "<string>",
      "hoverOrFocus": {
        "backgroundColor": "<string>",
        "color": "<string>"
      }
    },
    "search": {
      "backgroundColor": "<string>",
      "color": "<string>"
    }
  },
  "content": {
    "screen": {
      "background": "<string>",
      "backgroundColor": "<string>",
      "backgroundImage": "<string>",
      "backgroundSize": "<string>",
      "gutterTop": "<string>",
      "gutterRight": "<string>",
      "gutterBottom": "<string>",
      "gutterLeft": "<string>"
    },
    "container": {
      "background": "<string>",
      "backgroundColor": "<string>",
      "backgroundImage": "<string>",
      "backgroundSize": "<string>",
      "padding": "<string>",
      "borderRadius": "<string>"
    },
    "header": {
      "background": "<string>",
      "backgroundColor": "<string>",
      "backgroundImage": "<string>",
      "backgroundSize": "<string>",
      "padding": "<string>",
      "borderRadius": "<string>"
    },
    "body": {
      "background": "<string>",
      "backgroundColor": "<string>",
      "backgroundImage": "<string>",
      "backgroundSize": "<string>",
      "padding": "<string>",
      "borderRadius": "<string>"
    }
  },
  "bordersAndDividers": {
    "color": "<string>"
  }
}'

Responses

Returned if the look and feel settings are updated.

Content typeValue
application/json

allOf [LookAndFeel, object]

Reset look and feel settings

DELETE /wiki/rest/api/settings/lookandfeel/custom

Resets the custom look and feel settings for the site or a single space. This changes the values of the custom settings to be the same as the default settings. It does not change which settings (default or custom) are selected. Note, the default space settings are inherited from the current global settings.

Permissions required: 'Admin' permission for the space.

App scope requiredDELETE

OAuth scopes required
manage:confluence-configuration

Request

Query parameters
spaceKey

string

The key of the space for which the look and feel settings will be reset. If this is not set, the global look and feel settings will be reset.

Example

1
2
curl --request DELETE \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/settings/lookandfeel/custom'

Responses

Returned if the look and feel settings have been reset.

Set look and feel settings

PUT /wiki/rest/api/settings/lookandfeel/selected

Sets the look and feel settings to either the default settings or the custom settings, for the site or a single space. Note, the default space settings are inherited from the current global settings.

Permissions required: 'Admin' permission for the space.

App scope requiredWRITE

OAuth scopes required
manage:confluence-configuration

Request

Query parameters
spaceKey

string

The key of the space for which the look and feel settings will be set. If this is not set, the global look and feel settings will be set.

Body parameters

The object for choosing the look and feel settings for the site or a space.

selected Required

string

The look and feel scheme. If you set this to global, you must specify the current global look and feel settings as a global object in this request. Similarly, if you set this to custom, you must specify the current custom look and feel settings as a custom object in this request.

Valid values: global, custom

global

LookAndFeel

custom

LookAndFeel

Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
curl --request PUT \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/settings/lookandfeel/selected' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "selected": "global",
  "global": {
    "headings": {
      "color": "<string>"
    },
    "links": {
      "color": "<string>"
    },
    "menus": {
      "hoverOrFocus": {
        "backgroundColor": "<string>"
      },
      "color": "<string>"
    },
    "header": {
      "backgroundColor": "<string>",
      "button": {
        "backgroundColor": "<string>",
        "color": "<string>"
      },
      "primaryNavigation": {
        "color": "<string>",
        "hoverOrFocus": {
          "backgroundColor": "<string>",
          "color": "<string>"
        }
      },
      "secondaryNavigation": {
        "color": "<string>",
        "hoverOrFocus": {
          "backgroundColor": "<string>",
          "color": "<string>"
        }
      },
      "search": {
        "backgroundColor": "<string>",
        "color": "<string>"
      }
    },
    "content": {
      "screen": {
        "background": "<string>",
        "backgroundColor": "<string>",
        "backgroundImage": "<string>",
        "backgroundSize": "<string>",
        "gutterTop": "<string>",
        "gutterRight": "<string>",
        "gutterBottom": "<string>",
        "gutterLeft": "<string>"
      },
      "container": {
        "background": "<string>",
        "backgroundColor": "<string>",
        "backgroundImage": "<string>",
        "backgroundSize": "<string>",
        "padding": "<string>",
        "borderRadius": "<string>"
      },
      "header": {
        "background": "<string>",
        "backgroundColor": "<string>",
        "backgroundImage": "<string>",
        "backgroundSize": "<string>",
        "padding": "<string>",
        "borderRadius": "<string>"
      },
      "body": {
        "background": "<string>",
        "backgroundColor": "<string>",
        "backgroundImage": "<string>",
        "backgroundSize": "<string>",
        "padding": "<string>",
        "borderRadius": "<string>"
      }
    },
    "bordersAndDividers": {
      "color": "<string>"
    }
  },
  "custom": {
    "headings": {
      "color": "<string>"
    },
    "links": {
      "color": "<string>"
    },
    "menus": {
      "hoverOrFocus": {
        "backgroundColor": "<string>"
      },
      "color": "<string>"
    },
    "header": {
      "backgroundColor": "<string>",
      "button": {
        "backgroundColor": "<string>",
        "color": "<string>"
      },
      "primaryNavigation": {
        "color": "<string>",
        "hoverOrFocus": {
          "backgroundColor": "<string>",
          "color": "<string>"
        }
      },
      "secondaryNavigation": {
        "color": "<string>",
        "hoverOrFocus": {
          "backgroundColor": "<string>",
          "color": "<string>"
        }
      },
      "search": {
        "backgroundColor": "<string>",
        "color": "<string>"
      }
    },
    "content": {
      "screen": {
        "background": "<string>",
        "backgroundColor": "<string>",
        "backgroundImage": "<string>",
        "backgroundSize": "<string>",
        "gutterTop": "<string>",
        "gutterRight": "<string>",
        "gutterBottom": "<string>",
        "gutterLeft": "<string>"
      },
      "container": {
        "background": "<string>",
        "backgroundColor": "<string>",
        "backgroundImage": "<string>",
        "backgroundSize": "<string>",
        "padding": "<string>",
        "borderRadius": "<string>"
      },
      "header": {
        "background": "<string>",
        "backgroundColor": "<string>",
        "backgroundImage": "<string>",
        "backgroundSize": "<string>",
        "padding": "<string>",
        "borderRadius": "<string>"
      },
      "body": {
        "background": "<string>",
        "backgroundColor": "<string>",
        "backgroundImage": "<string>",
        "backgroundSize": "<string>",
        "padding": "<string>",
        "borderRadius": "<string>"
      }
    },
    "bordersAndDividers": {
      "color": "<string>"
    }
  }
}'

Responses

Returned if the look and feel settings were set.

Content typeValue
application/json

LookAndFeelSettings

Get system info

GET /wiki/rest/api/settings/systemInfo

Returns the system information for the Confluence Cloud tenant. This information is used by Atlassian.

Permissions required: Permission to access the Confluence site ('Can use' global permission).

App scope requiredREAD

OAuth scopes required
manage:confluence-configuration

Request

There are no parameters for this request.

Example

1
2
3
curl --request GET \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/settings/systemInfo' \
  --header 'Accept: application/json'

Responses

Returned if the system information for the Confluence Cloud tenant is returned.

Content typeValue
application/json

SystemInfoEntity

Rate this page: