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/
Query
The service's name.
dovecot— The Dovecot service.
Note:
For a fresh install, the data returned for the Dovecot service will only contain the list of protocols. It will not be until the mailserver configuration is saved that the return data for Dovecot will look like what is shown in the example.
Value"dovecot"
Example: service=dovecot
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/get_service_config
- A server running WHM.
https://whm-server.tld:2087/json-api/get_service_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/get_service_config?service=dovecot'HTTP Request was successful.
A list of the configuration key's settings.
Example: {"auth_cache_negative_ttl":3600,"auth_cache_size":"1M","auth_cache_ttl":3600,"auth_policy_hash_nonce":91057590,"compress_messages":0,"config_vsz_limit":2048,"auth_allow_cleartext":"yes","expire_trash":0,"expire_spam":0,"hulk_auth_passwd":"FAMONex4Bn9Hv1BO","include_trash_in_quota":0,"incoming_reached_quota":"bounce","ipv6":"on","lmtp_process_limit":500,"lmtp_process_min_avail":0,"lmtp_user_concurrency_limit":4,"login_max_processes_count":50,"login_process_per_connection":"no","login_process_size":128,"login_processes_count":2,"mail_process_size":512,"mdbox_rotate_interval":0,"mdbox_rotate_size":"10M","protocol_imap":{"mail_max_userip_connections":20,"map_idle_notify_interval":24},"protocol_pop3":{"mail_max_userip_connections":3},"protocols":"imap pop3","ssl_cipher_list":"ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305:DHE-RSA-AES128-GCM-SHA256:DHE-RSA-AES256-GCM-SHA384","ssl_min_protocol":"TLSv1.2"}
Response
application/json
{ "data": { "auth_cache_negative_ttl": 3600, "auth_cache_size": "1M", "auth_cache_ttl": 3600, "auth_policy_hash_nonce": 91057590, "compress_messages": 0, "config_vsz_limit": 2048, "auth_allow_cleartext": "yes", "expire_trash": 0, "expire_spam": 0, "hulk_auth_passwd": "FAMONex4Bn9Hv1BO", "include_trash_in_quota": 0, "incoming_reached_quota": "bounce", "ipv6": "on", "lmtp_process_limit": 500, "lmtp_process_min_avail": 0, "lmtp_user_concurrency_limit": 4, "login_max_processes_count": 50, "login_process_per_connection": "no", "login_process_size": 128, "login_processes_count": 2, "mail_process_size": 512, "mdbox_rotate_interval": 0, "mdbox_rotate_size": "10M", "protocol_imap": { … }, "protocol_pop3": { … }, "protocols": "imap pop3", "ssl_cipher_list": "ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305:DHE-RSA-AES128-GCM-SHA256:DHE-RSA-AES256-GCM-SHA384", "ssl_min_protocol": "TLSv1.2" }, "metadata": { "command": "get_service_config", "reason": "OK", "result": 1, "version": 1 } }
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/get_service_config_key
- A server running WHM.
https://whm-server.tld:2087/json-api/get_service_config_key
- 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_service_config_key?key=mail_process_size&service=dovecot'Response
application/json
{ "data": { "key name": "512", "mail_process_size": null }, "metadata": { "command": "get_service_config_key", "reason": "OK", "result": 1, "version": 1 } }
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/get_service_proxy_backends
- A server running WHM.
https://whm-server.tld:2087/json-api/get_service_proxy_backends
- 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_service_proxy_backends?username=example'Response
application/json
{ "data": { "payload": [ … ] }, "metadata": { "command": "get_service_proxy_backends", "reason": "OK", "result": 1, "version": 1 } }