Developer
News and Updates
Get Support
Sign in
Developer
Get Support
Sign in
DOCUMENTATION
Cloud
Data Center
Resources
News and Updates
Get support
Sign in
Developer
Sign in
DOCUMENTATION
Cloud
Data Center
Resources
News and Updates
Get support
Sign in
  • Access Mode
  • Admin Group
  • Admin Space
  • Admin User
  • Admin Users
  • Attachments
  • Backup and Restore
  • Category
  • Child Content
  • Cluster information
  • Content Blueprint
  • Content Body
  • Content Descendant
  • Content Labels
  • Content Property
  • Content Resource
  • Content Restrictions
  • Content Version
  • Content Watchers
  • Global Permissions
  • GlobalColorScheme
  • Group
  • Instance Metrics
  • Label
  • Long Task
  • Search
  • Server Information
  • Space
  • Space Label
  • Space Permissions
  • Space Property
  • Space Watchers
  • SpaceColorScheme
  • User
  • User Group
  • User Watch
  • Webhooks
  • Other operations
Server
Confluence Data Center / / REST API

GlobalColorScheme

Postman Collection
OpenAPI
Operations
GET/rest/api/color-scheme/defaultGET/rest/api/color-schemePUT/rest/api/color-schemePUT/rest/api/color-scheme/reset
GET

Get default global color scheme

Get default color scheme for the instance

Forge and OAuth2 apps cannot access this REST resource.

Request

This request has no parameters.

Responses

Returns a full JSON representation of color scheme including light and dark theme

application/json

ColorSchemeThemeBasedModel
GET/rest/api/color-scheme/default
1 2 3 curl --request GET \ --url 'http://{baseurl}/confluence/rest/api/color-scheme/default' \ --header 'Accept: application/json'
200Response
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 { "colorSchemeModelLight": { "topBarColor": "#000000", "topBarMenuSelectedBgColor": "#000000", "topBarMenuSelectedTextColor": "#000000", "breadcrumbsTextColor": "#000000", "headerButtonBgColor": "#000000", "headerButtonTextColor": "#000000", "searchFieldTextColor": "#000000", "searchFieldBgColor": "#000000", "menuItemSelectedBgColor": "#000000", "menuItemSelectedTextColor": "#000000", "menuItemTextColor": "#000000", "headingTextColor": "#000000", "linkColor": "#000000" }, "colorSchemeModelDark": { "topBarColor": "#000000", "topBarMenuSelectedBgColor": "#000000", "topBarMenuSelectedTextColor": "#000000", "breadcrumbsTextColor": "#000000", "headerButtonBgColor": "#000000", "headerButtonTextColor": "#000000", "searchFieldTextColor": "#000000", "searchFieldBgColor": "#000000", "menuItemSelectedBgColor": "#000000", "menuItemSelectedTextColor": "#000000", "menuItemTextColor": "#000000", "headingTextColor": "#000000", "linkColor": "#000000" } }
GET

Get global color scheme

Get information about the current color scheme for the instance

Forge and OAuth2 apps cannot access this REST resource.

Request

This request has no parameters.

Responses

Returns a full JSON representation of color scheme including light and dark theme

application/json

ColorSchemeThemeBasedModel
GET/rest/api/color-scheme
1 2 3 curl --request GET \ --url 'http://{baseurl}/confluence/rest/api/color-scheme' \ --header 'Accept: application/json'
200Response
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 { "colorSchemeModelLight": { "topBarColor": "#000000", "topBarMenuSelectedBgColor": "#000000", "topBarMenuSelectedTextColor": "#000000", "breadcrumbsTextColor": "#000000", "headerButtonBgColor": "#000000", "headerButtonTextColor": "#000000", "searchFieldTextColor": "#000000", "searchFieldBgColor": "#000000", "menuItemSelectedBgColor": "#000000", "menuItemSelectedTextColor": "#000000", "menuItemTextColor": "#000000", "headingTextColor": "#000000", "linkColor": "#000000" }, "colorSchemeModelDark": { "topBarColor": "#000000", "topBarMenuSelectedBgColor": "#000000", "topBarMenuSelectedTextColor": "#000000", "breadcrumbsTextColor": "#000000", "headerButtonBgColor": "#000000", "headerButtonTextColor": "#000000", "searchFieldTextColor": "#000000", "searchFieldBgColor": "#000000", "menuItemSelectedBgColor": "#000000", "menuItemSelectedTextColor": "#000000", "menuItemTextColor": "#000000", "headingTextColor": "#000000", "linkColor": "#000000" } }
PUT

Set global color scheme

Update the current color scheme of the instance

Forge and OAuth2 apps cannot access this REST resource.

Request

Request bodyapplication/json

New color scheme

colorSchemeModelLight

ColorSchemeModel

colorSchemeModelDark

ColorSchemeModel

Responses

Returns a full JSON representation of the updated color scheme

application/json

ColorSchemeThemeBasedModel
PUT/rest/api/color-scheme
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 curl --request PUT \ --url 'http://{baseurl}/confluence/rest/api/color-scheme' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "colorSchemeModelLight": { "topBarColor": "#000000", "topBarMenuSelectedBgColor": "#000000", "topBarMenuSelectedTextColor": "#000000", "breadcrumbsTextColor": "#000000", "headerButtonBgColor": "#000000", "headerButtonTextColor": "#000000", "searchFieldTextColor": "#000000", "searchFieldBgColor": "#000000", "menuItemSelectedBgColor": "#000000", "menuItemSelectedTextColor": "#000000", "menuItemTextColor": "#000000", "headingTextColor": "#000000", "linkColor": "#000000" }, "colorSchemeModelDark": { "topBarColor": "#000000", "topBarMenuSelectedBgColor": "#000000", "topBarMenuSelectedTextColor": "#000000", "breadcrumbsTextColor": "#000000", "headerButtonBgColor": "#000000", "headerButtonTextColor": "#000000", "searchFieldTextColor": "#000000", "searchFieldBgColor": "#000000", "menuItemSelectedBgColor": "#000000", "menuItemSelectedTextColor": "#000000", "menuItemTextColor": "#000000", "headingTextColor": "#000000", "linkColor": "#000000" } }'
200Response
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 { "colorSchemeModelLight": { "topBarColor": "#000000", "topBarMenuSelectedBgColor": "#000000", "topBarMenuSelectedTextColor": "#000000", "breadcrumbsTextColor": "#000000", "headerButtonBgColor": "#000000", "headerButtonTextColor": "#000000", "searchFieldTextColor": "#000000", "searchFieldBgColor": "#000000", "menuItemSelectedBgColor": "#000000", "menuItemSelectedTextColor": "#000000", "menuItemTextColor": "#000000", "headingTextColor": "#000000", "linkColor": "#000000" }, "colorSchemeModelDark": { "topBarColor": "#000000", "topBarMenuSelectedBgColor": "#000000", "topBarMenuSelectedTextColor": "#000000", "breadcrumbsTextColor": "#000000", "headerButtonBgColor": "#000000", "headerButtonTextColor": "#000000", "searchFieldTextColor": "#000000", "searchFieldBgColor": "#000000", "menuItemSelectedBgColor": "#000000", "menuItemSelectedTextColor": "#000000", "menuItemTextColor": "#000000", "headingTextColor": "#000000", "linkColor": "#000000" } }
PUT

Reset global color scheme

Reset the global color scheme colors to default

Forge and OAuth2 apps cannot access this REST resource.

Request

This request has no parameters.

Responses

Returns a full JSON representation of color scheme

application/json

ColorSchemeThemeBasedModel
PUT/rest/api/color-scheme/reset
1 2 3 curl --request PUT \ --url 'http://{baseurl}/confluence/rest/api/color-scheme/reset' \ --header 'Accept: application/json'
200Response
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 { "colorSchemeModelLight": { "topBarColor": "#000000", "topBarMenuSelectedBgColor": "#000000", "topBarMenuSelectedTextColor": "#000000", "breadcrumbsTextColor": "#000000", "headerButtonBgColor": "#000000", "headerButtonTextColor": "#000000", "searchFieldTextColor": "#000000", "searchFieldBgColor": "#000000", "menuItemSelectedBgColor": "#000000", "menuItemSelectedTextColor": "#000000", "menuItemTextColor": "#000000", "headingTextColor": "#000000", "linkColor": "#000000" }, "colorSchemeModelDark": { "topBarColor": "#000000", "topBarMenuSelectedBgColor": "#000000", "topBarMenuSelectedTextColor": "#000000", "breadcrumbsTextColor": "#000000", "headerButtonBgColor": "#000000", "headerButtonTextColor": "#000000", "searchFieldTextColor": "#000000", "searchFieldBgColor": "#000000", "menuItemSelectedBgColor": "#000000", "menuItemSelectedTextColor": "#000000", "menuItemTextColor": "#000000", "headingTextColor": "#000000", "linkColor": "#000000" } }

Rate this page: