Developer Documentation
Child pages
  • WHM API 1 Functions - delpkgext
Skip to end of metadata
Go to start of metadata

Guide to WHM API 1

Return Data

Filter Output

Sort Output

Paginate Output

Output Columns

Call cPanel API 2 and UAPI

 

 

Description


This function deletes a package extension from a hosting plan (package).

Examples

 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/delpkgext?api.version=1&name=package1&_DELETE_EXTENSIONS=extension1
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/delpkgext?api.version=1&name=package1&_DELETE_EXTENSIONS=extension1
 Command Line
whmapi1 delpkgext name=package1 _DELETE_EXTENSIONS=extension1


Notes:

  • You must URI-encode values.
  • For more information and additional output options, read our Guide to WHM API 1 documentation or run the whmapi1 --help command.

  • If you run CloudLinux™, you must use the full path of the whmapi1 command:

    /usr/local/cpanel/bin/whmapi1

 Output (JSON)
{
  "data": {
    "pkg": "package1"
  },
  "metadata": {
    "version": 1,
    "reason": "OK",
    "result": 1,
    "command": "delpkgext"
  }
}
 Output (XML)
<result>
    <data>
        <pkg>package1</pkg>
    </data>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>delpkgext</command>
    </metadata>
</result>


Note:

Use WHM's API Shell interface (WHM >> Home >> Development >> API Shell) to directly test WHM API calls.

   

Parameters

ParameterTypeDescriptionPossible valuesExample
name
string

Required

The hosting plan's name.

A valid hosting plan name.

package1
_DELETE_EXTENSIONS
string

Required

The package extension to delete.

A space-delimited list of one or more package extensions on the server.

Notes:

  • You can also include the extension's variables in your function call, in key=value format. Consult the extension's documentation for a list of possible variables.
  • Extension names and variables are case-sensitive.
extension1

Returns

ReturnTypeDescriptionPossible valuesExample

pkg

string

The new hosting plan's name.

The name input parameter's value.package1

Function information

API Version:

WHM API 1

Available in:

WHM 68+

Methods:

GET, POST

Required Parameters:

name, _DELETE_EXTENSIONS

Return Formats:

JSON, XML

Important:

cPanel & WHM version 66 deprecated XML output.

About WHM API 1

WHM API 1 performs functions and accesses data in WHM.

Notes:

  • Some functions and parameters may require that you authenticate as the root user.
  • You must use the appropriate WHM ports (2086 or 2087) to call WHM API functions.
  

Find a function

Related functions