Page tree
Skip to end of metadata
Go to start of metadata

 

Description

This function sets a customer's default style.

Note:

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/Styles/set_default?type=reseller&name=example

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.
 
// Set default style for reseller account.
$set_reseller_style = $cpanel->uapi(
    'Styles', 'set_default',
		array(
		'type'			=> 'reseller'
		'name'			=> 'example'
	)
 );

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 default style for resellers.
my $set_reseller_style = $cpliveapi->uapi(
    'Styles', 'list',
	{
		'type'			=> 'reseller'
		'name'			=> 'example'
	}
 );

Note:

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

 

 cPanel Template Toolkit
<!-- Set the default style. -->
[% execute('Styles', 'list', { type => 'reseller', name => 'example' } ); %]

Note:

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

 

 Command Line
uapi --user=username Styles set_default type=reseller name=example

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. 
  • We introduced this functionality in cPanel & WHM version 56.

 Output (JSON)
{
  "messages": null,
  "errors": null,
  "status": 1,
  "metadata": {
     
  },
  "data": null
}

Note:

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

   

Parameters

ParameterTypeDescriptionPossible valuesExample
typestring

Required

The style type.

  • default
  • global
  • reseller
reseller
namestring

Required

The directory that contains the style.

A valid directory name.example

Returns

This function only returns metadata.