UAPI Functions - Themes::update

Description

This function applies a new style to the cPanel interface.

Examples 


 cPanel or Webmail Session URL

https://hostname.example.com:2083/cpsess##########/execute/Themes/update?theme=paper_lantern

 LiveAPI PHP Class

$cpanel new CPANEL(); // Connect to cPanel - only do this once.
  
// Set new theme for example.com.
$set_theme $cpanel->uapi(
    'Styles''update',
        array(
        'theme'         => 'paper_lantern',
    )
 );

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Set new theme on example.com.
my $set_theme $cpliveapi->uapi(
    'Styles''update',
    {
        'theme'         => 'paper_lantern',
 
    }
 );

 cPanel Template Toolkit

<!-- Update the theme. -->
[% execute('Themes', 'update', { theme => 'paper_lantern', } ); %]

 Command Line

uapi --user=username Themes update theme=paper_lantern

 

Notes:

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

 Output (JSON)

{
  "messages": null,
  "errors": null,
  "status": 1,
  "metadata": {
      
  },
  "data": null
}

 

Note:

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

 

Parameters

 Parameter 

 Type 

Description

Possible values

Example

theme

string

Required

 The theme name. 

 An available cPanel theme. 

 paper_lantern 

 

Returns

 Return 

Type

Description

Possible values

 Example 

status

 Boolean 

 Whether the theme changed. 

  • 1 — Changed.
  • 0 — Did not change. 

1

 

  • 6 Users Found This Useful
Was this answer helpful?

Related Articles

The cPanel Interface

For  cPanel  &  WHM  version  58 Overview The cPanel interface is...

User Preferences

For cPanel & WHM version 58 Overview This document outlines how to access your cPanel...

Manage External Authentications

For cPanel & WHM version 58 Overview Manage credentials Additional documentation...

What is cPanelID?

In This Article:  Overview ServicesHow to get a cPanelID cPanelID External...

Guide to cPanel Interface Customization - cPanel Style Development

Introduction You can develop custom styles that modify the appearance of the cPanel interface....