cPanel module

Themes

3 functions, invoked through the cpanel_uapi tool.

scope cpanel:uapi

Call any function with cpanel_uapi(service_id, module="Themes", function, params). Live availability depends on the cPanel features JetHost has enabled on your account — call list_cpanel_operations to see what is active.

get_theme_base GET#

Return current theme

This function is deprecated and does not return useful output.

No parameters.

Response — normalized as { ok, data, errors[], warnings[] }; data contains:

The cPanel account's base theme. The function returns only one of the following strings: jupiter unknown — The function returns this value when it cannot determine the base theme that you modified to create the custom theme.

list GET#

Return available themes

This function lists available themes.

Note:

The /usr/local/cpanel/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.

show_mail_themesintegerOptional

Whether to list the account's mail themes. 1 — List mail themes. 0 — Do not list mail themes.

Response — normalized as { ok, data, errors[], warnings[] }; data is an array of:

An array that contains the account's themes.

update GET#

Update current theme

This function applies a new theme to the cPanel interface.

Note:

The /usr/local/cpanel/scripts/modify_accounts script allows you to modify the theme for many or all accounts on the server. For more information, read our The modify_accounts Script documentation.

themestringRequired

The theme name.

Response — normalized as { ok, data, errors[], warnings[] }; data contains:

Payload varies by call.