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

 

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 and Branding documentation.


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"


Note:

 For more information, read our Calls from the WHM API documentation.

 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',
    ) 
 );


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.
 
# Update the current dynamicui.conf file with a new item.
my $edit_dynamicui = $cpliveapi->api2(
    'Branding', 'addbrandingobj',
    { 
			'file'      => 'brandingchanges',
	}
 );


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

 Command Line
cpapi2 --user=username Branding addbrandingoobj file=brandingchanges


Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to cPanel API 2 documentation or run the cpapi2 --help command. 
  • We introduced this functionality in cPanel & WHM version 56.

 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 (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

 

Parameters

InputTypeDescriptionPossible valuesExample
filestring

Required

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

A valid filename.

brandingchanges

 

Returns

ReturnTypeDescriptionPossible valuesExample
statusBooleanWhether the function succeeded.
  • 1 — The function succeeded.
  • 0 — The function failed.
1
reasonstring

A message of success, or an error message.

  • OK
  • A string that describes the error.
OK
dynamicui.confstringThe dynamicui.conf file's location.

A valid file path, relative to the user's home directory.

/user/cpanelbranding/x3/mypackage/dynamicui.conf
resultBoolean

Whether the function succeeded.

  • 1 — The function succeeded.
  • 0 — The function failed.
1