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/
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/install_rpm_plugin
- A server running WHM.
https://whm-server.tld:2087/json-api/install_rpm_plugin
- 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/install_rpm_plugin?name=plugin+name'Response
application/json
{ "data": { "log_entry": "2017-01-01T19:39:27Z_plugin_name", "pid": 1234 }, "metadata": { "command": "install_rpm_plugin", "reason": "OK", "result": 1, "version": 1 } }
Query Examples: Examples:
The RPM package that you want to install. If you do not use this parameter, the function does not install a package.
Note:
You can pass this parameter multiple times to install more than one RPM package
install=install=package1 install=package2
install=package1
The RPM package that you want to uninstall. If you do not use this parameter, the function does not uninstall a package.
Note:
You can pass this parameter multiple times to uninstall more than one RPM package.
uninstall=uninstall=package3 uninstall=package4 uninstall=package5
uninstall=package3
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/package_manager_submit_actions
- A server running WHM.
https://whm-server.tld:2087/json-api/package_manager_submit_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_submit_actions?install=string&uninstall=string&upgrade=string'Response
application/json
{ "data": { "build": 9717 }, "metadata": { "command": "package_manager_submit_actions", "reason": "OK", "result": 1, "version": 1 } }
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/package_manager_upgrade
- A server running WHM.
https://whm-server.tld:2087/json-api/package_manager_upgrade
- 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_upgradeResponse
application/json
{ "data": { "build": 10111 }, "metadata": { "command": "package_manager_upgrade", "reason": "OK", "result": 1, "version": 1 } }