• Access Mode
  • Admin Group
  • Admin User
  • Attachments
  • Backup and Restore
  • Category
  • Child Content
  • Content Blueprint
  • Content Body
  • Content Descendant
  • Content Labels
  • Content Property
  • Content Resource
  • Content Restrictions
  • Content Version
  • Content Watchers
  • 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 / Reference / REST API

SpaceColorScheme

Postman Collection
OpenAPI
Operations
GET/rest/api/space/{spaceKey}/color-scheme/typePUT/rest/api/space/{spaceKey}/color-scheme/typeGET/rest/api/space/{spaceKey}/color-schemePUT/rest/api/space/{spaceKey}/color-schemePUT/rest/api/space/{spaceKey}/color-scheme/reset
GET

Get Space color scheme type

Get the current color scheme type used for a space, it can be global or custom

Request

Path parameters

spaceKey

string

Required

Responses

Returns a color scheme type

application/json

SpaceColorSchemeTypeModel
GET/rest/api/space/{spaceKey}/color-scheme/type
1 2 3 curl --request GET \ --url 'http://{baseurl}/confluence/rest/api/space/{spaceKey}/color-scheme/type' \ --header 'Accept: application/json'
200Response
1 2 3 { "type": "global" }
PUT

Update Space color scheme type

Update the color scheme type used for a space, currently it can be global or custom

Request

Path parameters

spaceKey

string

Required

Request bodyapplication/json

New color scheme type

type

string

Responses

Returns the updated color scheme type

application/json

SpaceColorSchemeTypeModel
PUT/rest/api/space/{spaceKey}/color-scheme/type
1 2 3 4 5 6 7 curl --request PUT \ --url 'http://{baseurl}/confluence/rest/api/space/{spaceKey}/color-scheme/type' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "type": "global" }'
200Response
1 2 3 { "type": "global" }
GET

Get Space color scheme

Get information about the current color scheme for a space

Request

Path parameters

spaceKey

string

Required

Responses

Returns a full JSON representation of color scheme

application/json

ColorSchemeThemeBasedModel
GET/rest/api/space/{spaceKey}/color-scheme
1 2 3 curl --request GET \ --url 'http://{baseurl}/confluence/rest/api/space/{spaceKey}/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

Update Space color scheme

Update the color scheme for a space

Request

Path parameters

spaceKey

string

Required

Request bodyapplication/json

New color scheme

colorSchemeModelLight

ColorSchemeModel

colorSchemeModelDark

ColorSchemeModel

Responses

Returns a full JSON representation of color scheme

application/json

ColorSchemeThemeBasedModel
PUT/rest/api/space/{spaceKey}/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/space/{spaceKey}/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 Space color scheme

Reset the space color scheme to use global color scheme

Request

Path parameters

spaceKey

string

Required

Responses

Returns a JSON representation of color scheme

application/json

ColorSchemeThemeBasedModel
PUT/rest/api/space/{spaceKey}/color-scheme/reset
1 2 3 curl --request PUT \ --url 'http://{baseurl}/confluence/rest/api/space/{spaceKey}/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: