Get System Branding

Get System Branding

Get the system level branding information including the portal name, portal color, selected theme and custom URLs.

Request
URI
GET
https://{api_host}/cloudapi/branding
COPY
Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns UiBranding of type(s) application/json;version=39.1 
{
    "portalName": "string",
    "portalColor": "string",
    "selectedTheme": {
        "themeType": "string",
        "name": "string"
    },
    "customLinks": [
        {
            "name": "string",
            "menuItemType": "string",
            "url": "string"
        }
    ]
}
string
portalName
Required

portalName

string
portalColor
Optional

A custom color defined by the administrator and used to theme the site. The color should be in rgb hex color format such as "FFFFFF" all capitalized. Can be set to an empty string to use the selected theme's default colors.

object
selectedTheme
Optional

A theme supported by vCloud Director.

array of object
customLinks
Required

An ordered list of menu items which can be customized and used in the application. Can be defined as a link, override (well known links that can be overridden, Default values are About, Help, VMRC), section, separator(section without a name) of the drop down menu.


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/cloudapi/branding
Availability
Added in 30.0
On This Page
Branding Operations
GET
Get System Branding
PUT
Put System Branding
Deprecated
GET
Get System Logo
PUT
Put System Logo
Deprecated
DELETE
Delete System Logo
Deprecated
GET
Get System Icon
PUT
Put System Icon
Deprecated
DELETE
Delete System Icon
Deprecated
GET
Get Tenant Branding
PUT
Put Tenant Branding
Deprecated
DELETE
Remove Tenant Branding
Deprecated
GET
Get Tenant Logo
PUT
Put Tenant Logo
Deprecated
DELETE
Delete Tenant Logo
Deprecated
GET
Get Tenant Icon
PUT
Put Tenant Icon
Deprecated
DELETE
Delete Tenant Icon
Deprecated
GET
Get Branding Themes
POST
Create Branding Theme
GET
Get Branding Theme
PUT
Update Branding Theme
DELETE
Delete Branding Theme
GET
Get Branding Theme Css
POST
Upload Branding Theme Contents
Deprecated
DELETE
Delete Branding Theme Contents
Deprecated