Return account branding information

For more information, read our Customization documentation.

Note:

cPanel accounts that do not use the Paper Lantern theme, or that use Paper Lantern without configured branding information, return blank values.

SecurityBasicAuth
Responses
200

HTTP Request was successful.

Response Schema: application/json
apiversion
integer

The version of the API.

func
string

The name of the method called.

module
string

The name of the module called.

object
get/Brand/read
Request samples
uapi --output=jsonpretty \
  --user=username \
  Brand \
  read
Response samples
application/json
{
  • "apiversion": 3,
  • "func": "read",
  • "module": "Brand",
  • "result": {
    • "data": {
      • "company_name": "Hosting Company, Inc.",
      • "cpanel_logo": "logo.svg",
      • "cpanel_logo_small": "logo_small.svg",
      • "display_company_name": 1,
      • "documentation_url": "http://www.hostingcompany.com/docs",
      • "is_default_logo": 1,
      • "webmail_display_company_name": 1,
      • "webmail_logo": "webmail.svg"
      },
    • "errors": null,
    • "messages": null,
    • "metadata": { },
    • "status": 1,
    • "warnings": null
    }
}