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/
Request
This function removes RPM data. When you call this function, it performs the same actions as the following command:
/usr/local/cpanel/scripts/update_local_rpm_versions --del section.key value
For more information, read our rpm.versions system documentation.
Note:
After you call this function, we strongly recommend that you run the /usr/local/cpanel/scripts/check_cpanel_pkgs script.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/delete_rpm_version
- A server running WHM.
https://whm-server.tld:2087/json-api/delete_rpm_version
- 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/delete_rpm_version?key=3rdparty§ion=rpm_groups&value=cpanel-pcre'Response
application/json
{ "data": { "status": 1 }, "metadata": { "command": "delete_rpm_version", "reason": "OK", "result": 1, "version": 1 } }
Request
This function edits RPM data. When you call this function, it performs the same actions as the following command:
/usr/local/cpanel/scripts/update_local_rpm_versions --edit section.key value
For more information, read our rpm.versions system documentation.
Note:
After you call this function, we strongly recommend that you run the /usr/local/cpanel/scripts/check_cpanel_pkgs script.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/edit_rpm_version
- A server running WHM.
https://whm-server.tld:2087/json-api/edit_rpm_version
- 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/edit_rpm_version?key=3rdparty§ion=rpm_groups&value=cpanel-pcre'Response
application/json
{ "data": { "status": 1 }, "metadata": { "command": "edit_rpm_version", "reason": "OK", "result": 1, "version": 1 } }
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/package_manager_fixcache
- A server running WHM.
https://whm-server.tld:2087/json-api/package_manager_fixcache
- 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_fixcacheResponse
application/json
{ "data": { "cache_seems_ok_now": 1 }, "metadata": { "command": "package_manager_fixcache", "reason": "OK", "result": 1, "version": 1 } }