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/get_unique_sender_recipient_count_per_user
- A server running WHM.
https://whm-server.tld:2087/json-api/get_unique_sender_recipient_count_per_user
- 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/get_unique_sender_recipient_count_per_user?end_time=1551192100&start_time=1550702383'Response
application/json
{ "data": { "payload": [ … ] }, "metadata": { "command": "get_unique_sender_recipient_count_per_user", "reason": "OK", "result": 1, "version": 1 } }
Request
This function retrieves the destination to which the system forwards a system account's email.
Note:
- Usually, the system sends notices about the server's problems and activity to the
rootaccount. - If you do not use the
suexecmodule, thenobodyuser receives bounce messages from email that CGI scripts send.
Important:
When you disable the Receive Mail role, the system disables this function.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/get_user_email_forward_destination
- A server running WHM.
https://whm-server.tld:2087/json-api/get_user_email_forward_destination
- 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/get_user_email_forward_destination?user=root'Response
application/json
{ "data": { "forward_to": [ … ] }, "metadata": { "command": "get_user_email_forward_destination", "reason": "OK", "result": 1, "version": 1 } }
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/hold_outgoing_email
- A server running WHM.
https://whm-server.tld:2087/json-api/hold_outgoing_email
- 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/hold_outgoing_email?user=example'Response
application/json
{ "metadata": { "command": "hold_outgoing_email", "reason": "OK", "result": 1, "version": 1 } }