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 returns a list of all EasyApache 4 profiles and the packages that each profile provides.
Important:
When you disable the Web Server role, the system disables this function.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/ea4_list_profiles
- A server running WHM.
https://whm-server.tld:2087/json-api/ea4_list_profiles
- 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/ea4_list_profilesResponse
application/json
{ "data": { "cpanel": [ … ], "custom": [ … ], "property1": [ … ], "property2": [ … ] }, "metadata": { "command": "ea4_list_profiles", "reason": "OK", "result": 1, "version": 1 } }
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/ea4_metainfo
- A server running WHM.
https://whm-server.tld:2087/json-api/ea4_metainfo
- 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/ea4_metainfoResponse
application/json
{ "data": { "additional_packages": [ … ], "default_php_handler": "cgi", "default_php_package": "ea-php72", "type": "object" }, "metadata": { "command": "ea4_metainfo", "reason": "OK", "result": 1, "version": 1 } }
Request
This function returns any recommendations attached to your installed EasyApache 4 packages. For more information about the recommendation system, read our EasyApache 4 Recommendations documentation.
Important:
When you disable the Web Server role, the system disables this function.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/ea4_recommendations
- A server running WHM.
https://whm-server.tld:2087/json-api/ea4_recommendations
- 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/ea4_recommendationsHTTP Request was successful.
Example: {"ea-php55-php":[{"desc":"PHP DSO runs as the user by default. In a shared hosting environment, this is a security issue.","level":"danger","name":"PHP DSO","on":"add","options":[{"items":["ruid2","mpm-itk"],"level":"success","recommended":true,"text":"We strongly recommend that you install one of the following packages unless this is a single-user system:"},{"level":"warning","recommended":false,"text":"If you use suPHP, you will add some security, but may experience performance issues on your server."}],"url":"https://www.example.com"}]}
Response
application/json
{ "data": { "ea-php55-php": [ … ] }, "metadata": { "command": "ea4_recommendations", "reason": "OK", "result": 1, "version": 1 } }