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/normalize_user_email_configuration
- A server running WHM.
https://whm-server.tld:2087/json-api/normalize_user_email_configuration
- 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/normalize_user_email_configuration?username=username'Response
application/json
{ "metadata": { "command": "normalize_user_email_configuration", "reason": "OK", "result": 1, "version": 1 } }
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/rebuild_mail_sni_config
- A server running WHM.
https://whm-server.tld:2087/json-api/rebuild_mail_sni_config
- 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/rebuild_mail_sni_config?reload_dovecot=1'Response
application/json
{ "data": { "configs_built": [ … ], "success": 1 }, "metadata": { "command": "rebuild_mail_sni_config", "reason": "OK", "result": 1, "version": 1 } }
Request
This function removes in-progress Exim configuration files after a failed update to Exim. When cPanel & WHM attempts to update an Exim configuration, the system creates dry run files to replace of the ordinary configuration files.
Note:
- If the update fails, the system leaves these dry run files in place.
- When the user accesses the Advanced Editor section of WHM's Exim Configuration Manager interface (Home >> Service Configuration >> Exim Configuration Manager), they access these dry run files instead of the actual configuration files.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/remove_in_progress_exim_config_edit
- A server running WHM.
https://whm-server.tld:2087/json-api/remove_in_progress_exim_config_edit
- 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/remove_in_progress_exim_config_editResponse
application/json
{ "metadata": { "command": "remove_in_progress_exim_config_edit", "reason": "Removed OK", "result": 1, "version": 1 } }