WHM API.
Download OpenAPI description
Overview
URL
WebPros International, LLC
License
Languages
Servers
Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/
A server running WHM.
https://{host}:{port}/json-api/
Query
Return RPM packages that exist in a specified state.
any— All RPMs available on the system.installed— The RPMs installed on the system.not_installed— The available RPMs not yet installed on the system.updatable— The RPMs with updates available.
Default "any"
Enum"any""installed""not_installed""updatable"
Example: state=installed
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/package_manager_list_packages
- A server running WHM.
https://whm-server.tld:2087/json-api/package_manager_list_packages
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://api.docs.cpanel.net/_mock/specifications/whm.openapi/package_manager_list_packages?state=installed'Response
application/json
{ "data": { "packages": [ … ] }, "metadata": { "command": "package_manager_list_packages", "reason": "OK", "result": 1, "version": 1 } }
Query Examples:
The name of an RPM package.
Note:
- To submit more than one package, pass the parameter multiple times. For example,
package=ea-php55andpackage=ea-apr-util.
package=package=ea-apache24-mod_headers package=ea-apache24-mod_cgid package=ea-apache24-mod_mpm_event
package=ea-apache24-mod_headers
The RPM namespace that represents a set of packages. Note:
eaand any fromea4_get_additional_pkg_prefixesAPI call are the only possible values. * When more than one namespace is involved, pass the parameter multiple times. For example,ns=eaandns=altea.
Value"ea"
Examples: ns=ns=ea ns=altea
ns=ea
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/package_manager_resolve_actions
- A server running WHM.
https://whm-server.tld:2087/json-api/package_manager_resolve_actions
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://api.docs.cpanel.net/_mock/specifications/whm.openapi/package_manager_resolve_actions?package=string&ns=ea'Response
application/json
{ "data": { "install": [ … ], "unaffected": [ … ], "uninstall": [ … ], "upgrade": [ … ] }, "metadata": { "command": "package_manager_resolve_actions", "reason": "OK", "result": 1, "version": 1 } }