UAPI Functions - Styles::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/Styles/update?type=reseller&name=example

 LiveAPI PHP Class

$cpanel new CPANEL(); // Connect to cPanel - only do this once.
  
// Set new style for example.com.
$set_style $cpanel->uapi(
    'Styles''update',
        array(
        'type'          => 'reseller'
        'name'          => 'example'
    )
 );

 LiveAPI Perl Module

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

 cPanel Template Toolkit

<!-- Update the style. -->
[% execute('Styles', 'update', { type => 'reseller', name => 'example' } ); %]

 Command Line

uapi --user=username Styles update type=reseller name=example

 

Notes:

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

 Output (JSON)

{
  "messages": null,
  "errors": null,
  "status": 1,
  "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 

type

string

Required

The style type.

  • default
  • global
  • reseller

reseller

name

 string 

Required

 The directory that contains the style. 

 A valid directory name. 

example

 

Returns

This function only returns metadata.

 

  • 0 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....