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 lists the status of a cPanel's mail account's mailboxes.
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_mailbox_status_list
- A server running WHM.
https://whm-server.tld:2087/json-api/get_mailbox_status_list
- 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_mailbox_status_list?account=user%40example.com'Response
application/json
{ "data": { "mailboxes": [ … ] }, "metadata": { "command": "get_mailbox_status_list", "reason": "OK", "result": 1, "version": 1 } }
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/get_unique_recipient_count_per_sender_for_user
- A server running WHM.
https://whm-server.tld:2087/json-api/get_unique_recipient_count_per_sender_for_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_recipient_count_per_sender_for_user?end_time=1550923200&start_time=1550872800&user=username'Response
application/json
{ "data": { "payload": [ … ] }, "metadata": { "command": "get_unique_recipient_count_per_sender_for_user", "reason": "OK", "result": 1, "version": 1 } }
- 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 } }