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

 

Description

This function deletes items from 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=delbrandingobj&opt=description%3D%3E%24LANG%7B'FTP%20Accounts'%7D%2Citemdesc%3D%3E%24LANG%7B'FTP%20Accounts'%7D%2Curl%3D%3Eftp%2Faccounts.html%2Cfeature%3D%3Eftpaccts%2Ctouch%3D%3Eftp%2Cgroup%3D%3Efiles%2Citemorder%3D%3E6%2Cfile%3D%3Eftp_accounts%2Cimgtype%3D%3Eicon%2Ctype%3D%3Eimage%2Csubtype%3D%3Eimg%2Cwidth%3D%3E48%2Cheight%3D%3E48%2Csearchtext%3D%3E%24LANG%7B'FTP%20Accounts%20ftp%20create%5Bcomment%26%2344%3Bsearch%20text%20keywords%5D'%7D


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.
 
// Delete an item from the current dynamicui.conf file.
$del_dynamicui = $cpanel->api2(
    'Branding', 'delbrandingobj',
		array(        
			'opt'      => 'description=>$LANG{\'FTP Accounts\'},itemdesc=>$LANG{\'FTP Accounts\'},url=>ftp/accounts.html,feature=>ftpaccts,touch=>ftp,group=>files,itemorder=>6,file=>ftp_accounts,imgtype=>icon,type=>image,subtype=>img,width=>48,height=>48,searchtext=>$LANG{\'FTP Accounts ftp create[comment,search text keywords]\'}',
    ) 
 );


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.
 
# Delete an item from the current dynamicui.conf file.
my $del_dynamicui = $cpliveapi->api2(
    'Branding', 'delbrandingobj',
    { 
			'opt'      => "description=>$LANG{\'FTP Accounts\'},itemdesc=>$LANG{\'FTP Accounts\'},url=>ftp/accounts.html,feature=>ftpaccts,touch=>ftp,group=>files,itemorder=>6,file=>ftp_accounts,imgtype=>icon,type=>image,subtype=>img,width=>48,height=>48,searchtext=>$LANG{\'FTP Accounts ftp create[comment,search text keywords]\'}",
	}
 );


Note:

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

 

 cPanel Tag System (deprecated)


Warnings:

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

 Command Line
cpapi2 --user=username Branding delbrandingobj opt=description%3D%3E%24LANG%7B%5C%27FTP%20Accounts%5C%27%7D%2Citemdesc%3D%3E%24LANG%7B%5C%27FTP%20Accounts%5C%27%7D%2Curl%3D%3Eftp%2Faccounts.html%2Cfeature%3D%3Eftpaccts%2Ctouch%3D%3Eftp%2Cgroup%3D%3Efiles%2Citemorder%3D%3E6%2Cfile%3D%3Eftp_accounts%2Cimgtype%3D%3Eicon%2Ctype%3D%3Eimage%2Csubtype%3D%3Eimg%2Cwidth%3D%3E48%2Cheight%3D%3E48%2Csearchtext%3D%3E%24LANG%7B%5C%27FTP%20Accounts%20ftp%20create%5Bcomment%26%2344%3Bsearch%20text%20keywords%5D%5C%27%7D


Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • You must run the --user=username command.
  • For more information and additional output options, read our Guide to cPanel API 2 documentation or run the cpapi2 --help command.
  • If you run CloudLinux™, you must use the full path of the cpapi2 command:

    /usr/local/cpanel/bin/cpapi2

 Output (JSON)
{
  "cpanelresult": {
    "apiversion": 2,
    "func": "delbrandingobj",
    "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
optstring

Required

A line to delete from the dynamicui.conf file.

A dynamicui.conf line.

 Click to view...

description=>$LANG{'FTP Accounts'},itemdesc=>$LANG{'FTP Accounts'},url=>ftp/accounts.html,feature=>ftpaccts,touch=>ftp,group=>files,itemorder=>6,file=>ftp_accounts,imgtype=>icon,type=>image,subtype=>img,width=>48,height=>48,searchtext=>$LANG{'FTP Accounts ftp create[comment,search text keywords]'} 

 

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