Get System Branding | VMware Cloud Director OpenAPI

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.

ApiKeyAuth

Responses

200

Returns UiBranding of type(s) application/json;version=39.0

{
    "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.

UiTheme

selectedTheme

Optional

A theme supported by vCloud Director.

array of UiBrandingMenuItem

customLinks

Required

customLinks

Availability

Added in 30.0

On This Page

Description