Description

This function deletes a branding package.

 

Examples


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

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Delete the mypkg branding package.
$delete_branding_pkg = $cpanel->api2(
    'Branding', 'delpkg',
		array(        
			'pkg'      => 'mypkg',
    ) 
 );

 

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Delete the mypkg branding package.
my $delete_branding_pkg = $cpliveapi->api2(
    'Branding', 'delpkg',
    { 
			'pkg'      => 'mypkg',
	}
 );

 

cpapi2 --user=username Branding delpkg pkg=mypkg

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "delpkg",
    "data": [
      {
        "pkg": "mypkg"
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Branding"
  }
}

 

Parameters

InputTypeDescriptionPossible valuesExample
pkgstring

Required

The branding package name.

The name of a branding package that the cPanel account owns.

 

mypkg

 

Returns

ReturnTypeDescriptionPossible valuesExample
errorstring

An error message.

This function only returns an error value if it failed. 

A string that describes the error./home/example/cpanelbranding/x3/mypkg does not exist!
pkgstringThe branding package name.

The pkg parameter's value.

mypkg
resultBoolean

Whether the function succeeded.

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