cPanel API 2 Functions - Branding::brandingeditor - Knowledgebase

Description

This function updates objects in a branding package's dynamicui.conf file.

Note:

cPanel API 2's Branding module only modifies data for the x3 theme.

To customize the Paper Lantern theme, use UAPI functions. For more information, read our Guide to cPanel Interface Customization documentation.
For more information about x3 theme customizations, read our Legacy Guide to x3 Theme Brandingdocumentation.

Warning:

We strongly recommend that you use UAPI instead of cPanel API 2. However, no equivalent UAPI function exists.

Examples

WHM API (JSON)

https://hostname.example.com:2087/cpsess###########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=Branding&cpanel_jsonapi_func=brandingeditor&type=

 LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// Update the dynamicui.conf file.
$update_dynamicui = $cpanel->api2(
    'Branding', 'brandingeditor',
        array(       
            'type'           => 'image',
            'imgtype'        => 'icon',
            'showdeleted'    => '1',
    )
 );

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Update the dynamicui.conf file.
my $update_dynamicui = $cpliveapi->api2(
    'Branding', 'brandingeditor',
    {
            'type'           => 'image',
            'imgtype'        => 'icon',
            'showdeleted'    => '1',
    }
 );

cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

cPanel API 2 calls that use cPanel tags vary widely in code syntax and in their output. For more information, read our Deprecated cPanel Tag Usage documentation. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.

Knowledgebase

Categories

Categories