Child pages
  • cPanel API 2 Functions - Branding::delpkg

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

 

Description

Excerpt

This function deletes a branding package.

Include Page
LIB:_cPanelAPI2BrandingNote
LIB:_cPanelAPI2BrandingNote

Include Page
LIB:_cPanelAPI2NoEquivalent
LIB:_cPanelAPI2NoEquivalent

 

Panel
bgColor#F2F2F2
borderStylenone

Examples


Panel
bgColor#FFFFFF
borderStylenone
Expand
titleWHM API (JSON)
Code Block
languagetext
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"

Include Page
LIB:_CallFromWHMAPILink
LIB:_CallFromWHMAPILink

Expand
titleLiveAPI PHP Class
Code Block
languagephp
linenumberstrue
$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',
    ) 
 );

Include Page
LIB:_LiveAPIPHPLink
LIB:_LiveAPIPHPLink

 

Expand
titleLiveAPI Perl Module
Code Block
languageperl
linenumberstrue
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',
	}
 );

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink

 

Expand
titlecPanel Tag System (deprecated)

Include Page
LIB:_cPanelAPI2cPanelTagsWarning
LIB:_cPanelAPI2cPanelTagsWarning

Expand
titleCommand Line
Code Block
languagebash
cpapi2 --user=username Branding delpkg pkg=mypkg

Include Page
LIB:_cPanelAPI2CLINote
LIB:_cPanelAPI2CLINote

Expand
titleOutput (JSON)
Code Block
languagetext
linenumberstrue
{
  "cpanelresult": {
    "apiversion": 2,
    "func": "delpkg",
    "data": [
      {
        "pkg": "mypkg"
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Branding"
  }
}

Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote

 

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.

Note
titleNote:

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