UAPI Functions - Themes::list

In cPanel & WHM version 66 and later, the /scripts/modify_accounts script allows you to modify the style and theme for many or all accounts on the server. For more information, read our The modify_accounts Script documentation.

Examples

cPanel or Webmail Session URL

https://hostname.example.com:2083/cpsess##########/execute/Themes/list?show_mail_themes=1

Note:

This example calls the UAPI function via a cPanel session. For more information, read our Guide to UAPI documentation.

LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// List themes for example.com.
$list_themes = $cpanel->uapi(
    'Themes', 'list',
		array(
		'show_mail_themes'			=> '1',
	)
 );

Note:

For more information, read our Guide to the LiveAPI System.

LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Set list themes on example.com.
my $list_theme = $cpliveapi->uapi(
    'Themes', 'list',
	{
		'show_mail_themes'			=> '1',

	}
 );

Note:

For more information, read our Guide to the LiveAPI System.

cPanel Template Toolkit

<!-- List the themes. -->
[% execute('Themes', 'list', { show_mail_themes => '1', } ); %]

Note:

For more information, read our Guide to Template Toolkit documentation.

Command Line

uapi --user=username Themes list show_mail_themes=1

Notes:

You must URI-encode values.
username represents your account-level username.
For more information and additional output options, read our Guide to UAPI documentation or run the uapi --help command.
If you run CloudLinux™, you must use the full path of the uapi command:
```
/usr/local/cpanel/bin/uapi
```

Output (JSON)

{  
   "messages":null,
   "metadata":{  
      "transformed":1
   },
   "data":[  
      "paper_lantern"
   ],
   "status":1,
   "errors":null
}

Note:

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

Parameters

Parameter Type Description Possible values Example

show_mail_themes

string

Whether to list the account's mail themes.

This parameter defaults to 0.

1 — List mail themes.
0 — Do not list mail themes.

1

Returns

Return	Type	Description	Possible values	Example
`data`	array	An array that contains the account's themes.	One or more available themes.	`paper_lantern`

Function information

Module:

Themes

API Version:

UAPI

Available in:

cPanel 11.42+

Methods:

GET, POST

Required Parameters:

(none)

Return Formats:

JSON, XML

Legacy Equivalents:

Themes::get_themes_list

About this module

The Themes module manages the account's theme.

About UAPI

UAPI accesses and modifies data for cPanel accounts.

Notes:

These functions may require specific features. To enable or disable features, use WHM's Feature Manager interface.
Unless you call this API via the WHM API, you must use the appropriate cPanel ports (2082 or 2083). You can also call some functions via cPanel's Webmail ports (2095 or 2096).

Find a function

Related functions

Page:

UAPI Modules - Brand — The Brand module accesses branding data.
Page:

UAPI Functions - Brand::read — This function retrieves the cPanel account's branding information.
Page:

UAPI Modules - Branding — The Branding module accesses cPanel's theming system.
Page:

UAPI Functions - Branding::file — This function retrieves a branding file's path.
Page:

UAPI Functions - Branding::get_application_information — This function retrieves an application's information from the dynamicui.conf file.

Child pages

UAPI Functions - Themes::list

Description

Examples

Parameters

Returns

Function information

About this module

About UAPI

Find a function

Search

Related functions