- Created by Documentation, last modified on Apr 09, 2018
Use WHM API to Call cPanel API & UAPI
disable_authentication_provider
disable_failing_authentication_providers
enable_authentication_provider
get_available_authentication_providers
get_provider_client_configurations
get_provider_configuration_fields
get_provider_display_configurations
get_users_authn_linked_accounts
set_provider_client_configurations
set_provider_display_configurations
twofactorauth_generate_tfa_config
twofactorauth_get_user_configs
cpgreylist_is_server_netblock_trusted
cpgreylist_list_entries_for_common_mail_provider
cpgreylist_load_common_mail_providers_config
cpgreylist_save_common_mail_providers_config
cpgreylist_trust_entries_for_common_mail_provider
cpgreylist_untrust_entries_for_common_mail_provider
create_cpgreylist_trusted_host
delete_cpgreylist_trusted_host
Description
This function deletes a package extension from a hosting plan (package).
Examples
https://hostname.example.com:2087/cpsess##########/json-api/delpkgext?api.version=1&name=package1&_DELETE_EXTENSIONS=extension1
https://hostname.example.com:2087/cpsess##########/xml-api/delpkgext?api.version=1&name=package1&_DELETE_EXTENSIONS=extension1
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. - We introduced this functionality in cPanel & WHM version 11.52.0.8.
{ "data": { "pkg": "package1" }, "metadata": { "version": 1, "reason": "OK", "result": 1, "command": "delpkgext" } }
<result> <data> <pkg>package1</pkg> </data> <metadata> <version>1</version> <reason>OK</reason> <result>1</result> <command>delpkgext</command> </metadata> </result>
Note:
Parameters
Parameter | Type | Description | Possible values | Example |
---|---|---|---|---|
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:
| extension1 |
Returns
Return | Type | Description | Possible values | Example |
---|---|---|---|---|
| string | The new hosting plan's name. | The name input parameter's value. | package1
|
Function information
API Version:
Available in:
WHM 68+
Methods:
GET, POST
Required Parameters:
name
, _DELETE_EXTENSIONS
Return Formats:
About WHM API 1
WHM API 1 performs functions and accesses data in WHM.
Notes:
- Some functions and parameters may require that the you authenticate as the
root
user. - You must use the appropriate WHM ports (
2086
or2087
) to call WHM API functions.
Find a function
Related functions
-
Page:WHM API 1 Functions - changepackage — This function changes a cPanel account's hosting plan (package).
-
Page:WHM API 1 Functions - killpkg — This function deletes a hosting plan (package).
-
Page:WHM API 1 Functions - _getpkgextensionform — This function retrieves a hosting plan's package extension templates.
-
Page:WHM API 1 Sections - Packages — Package functions allow you to manage hosting plans for resellers and cPanel users.
-
Page:WHM API 1 Functions - addpkgext — This function adds a package extension to a hosting plan (package).