Child pages
  • cPanel API 1 Functions - Branding::setupdirs
Skip to end of metadata
Go to start of metadata

 

Description

This function creates an account's /cpanelbranding directory and subdirectories, and sets its permissions.

Warning:

cPanel API 1 is deprecated. We strongly recommend that you do not use cPanel API 1. However, no equivalent function exists in our newer APIs.

Examples


 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$branding_dir = $cpanel->api1('Branding', 'setupdir', array('public_html') ); // Call the function.


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.
my $branding_dir = $cpliveapi->api1('Branding', 'setupdirs', ['public_html'] ); # Call the function.


Note:

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

 

 cPanel Tag System (deprecated)


Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We provide this example to help developers move from the old cPanel tag system to our LiveAPI system. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

<cpanel Module="Branding::setupdirs( $FORM('ownerhomedir') )">
 Command Line
cpapi1 --user=username Branding setupdirs public_html x3 package1


Notes:

  • You must URI-encode these values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to cPanel API 1 documentation or run the cpapi1 --help command. 

 Output (URL)

This function does not return output.

 

Parameters

ParameterTypeDescriptionPossible valuesExample
ownerhomedirstring

Required

The account owner's /home directory's filepath.

A valid directory name.public_html
themestringThe account's theme.

 

 

A valid theme.

x3
brandingpkgstring

The branding package name.

A valid branding package name.

package1

Returns

This function does not return output.