cPanel API 2 Functions - Branding::addbrandingobj - Knowledgebase

Description

This function adds an item to the current 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=addbrandingobj&file="brandingchanges"

LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Update the current dynamicui.conf file with a new item.
$edit_dynamicui = $cpanel->api2(
    'Branding', 'addbrandingobj',
		array(        
			'file'      => 'brandingchanges',
    ) 
 );

LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Update the current dynamicui.conf file with a new item.
my $edit_dynamicui = $cpliveapi->api2(
    'Branding', 'addbrandingobj',
    { 
			'file'      => 'brandingchanges',
	}
 );

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.

Output (JSON)

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "addbrandingobj",
    "data": [
      {
        "status": "1"
        "reason": "OK"
        "dynamicui.conf": "/user/cpanelbranding/x3/mypackage/dynamicui.conf"
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Branding"
  }
}

Note:

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

Parameters

Input	Type	Description	Possible values	Example
file	string	Required A file that contains the lines to add to the dynamicui.conffile.	A valid filename.	brandingchanges

Input

Type

Description

Possible values

Example

file

string

Required

A file that contains the lines to add to the dynamicui.conffile.

A valid filename.

brandingchanges

Returns

Return	Type	Description	Possible values	Example
status	boolean	Whether the function succeeded.	1 — The function succeeded. 0 — The function failed.	1
reason	string	A message of success, or an error message.	OK A string that describes the error.	OK
dynamicui.conf	string	Thedynamicui.conffile's location.	A valid filepath, relative to the user's home directory.	/user/cpanelbranding/x3/mypackage/dynamicui.conf
result	boolean	Whether the function succeeded.	1 — The function succeeded. 0 — The function failed.	1

Knowledgebase

Categories

Categories