UAPI Functions - Brand::read - Knowledgebase

Description

This function retrieves the cPanel account's branding information. For more information, read our Branding documentation.

Note:

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

Examples

cPanel or Webmail Session URL

https://hostname.example.com:2083/cpsess##########/execute/Brand/read

LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.

// Get Paper Lantern branding settings.

$pl_branding = $cpanel->uapi(

'Brand', 'read'

);

LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.

# Get Paper Lantern branding settings.

my $pl_branding = $cpliveapi->uapi(

'Brand', 'read',

);

 cPanel Template Toolkit

<!-- Get a hash of all the data, then display the company_name value. -->
[% data = execute( 'Brand', 'read' ); %]
[% FOREACH q = data.company_name %]
     <p>
         [% q %]
     </p>
[% END %]
  
 
<!-- Get only the company name. -->
[% execute('Brand', 'read' ).data.company_name %]

Command Line

uapi --user=username Brand read

Notes:

You must URI-encode values.
username represents your account-level username.

 Output (JSON)

{
  "messages": null,
  "errors": null,
  "status": 1,
  "metadata": {
     
  },
  "data": {
    "company_name": "Hosting Company, Inc.",
    "documentation_url": "http://www.hostingcompany.com/docs",
    "help_url": "http://www.hostingcompany.com/support",
    "display_company_name": 1
  }
}

Note:

Use cPanel's API Shell interface (Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

This function does not accept parameters.

Returns

Return	Type	Description	Possible values	Example
company_name	string	The company name. This name appears in the top left corner of the branded cPanel interface.	A string value. An empty string.	Hosting Company, Inc.
documentation_url	string	The company's documentation URL. The Documentation link uses this URL in branded cPanel interfaces.	A valid URL. An empty string.	http://www.hostingcompany.com/docs
help_url	string	The company's support URL. In cPanel & WHM version 11.48 and earlier, the Helplink uses this URL in branded cPanel interfaces. Note: In cPanel & WHM version 11.50 and later, we removed theHelp link from the cPanel interface.	A valid URL. An empty string.	http://www.hostingcompany.com/support
display_company_name	Boolean	Whether the cPanel interface displays the company_namevalue or a logo in the branded cPanel interface.	1 — Display thecompany_namevalue. 0 — Display the company's logo.	1

Knowledgebase

Categories

Categories