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/list_blocked_incoming_email_countries
- A server running WHM.
https://whm-server.tld:2087/json-api/list_blocked_incoming_email_countries
- 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/list_blocked_incoming_email_countriesResponse
application/json
{ "data": { "countries": [ … ] }, "metadata": { "command": "list_blocked_incoming_email_countries", "reason": "OK", "result": 1, "version": 1 } }
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/list_blocked_incoming_email_domains
- A server running WHM.
https://whm-server.tld:2087/json-api/list_blocked_incoming_email_domains
- 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/list_blocked_incoming_email_domainsResponse
application/json
{ "data": { "domains": [ … ] }, "metadata": { "command": "list_blocked_incoming_email_domains", "reason": "OK", "result": 1, "version": 1 } }
Request
This function configures your Apache SpamAssassin™ options.
Important:
When you disable the Spam Filter role, the system disables this function.
Security
BasicAuth
Query
A comma-separated list of IP addresses to authorize to access the spamd daemon.
Note:
- If you do not specify a value, the
spamddaemon allows connections from any IP address. - If you set a value for this parameter, it must include
127.0.0.1in the list of values so that thechkservddaemon can access thespamddaemon.
Example: allowedips=127.0.0.1,192.168.0.1
The maximum number of connections that the spamd daemon allows per child process.
Example: maxconnperchild=200
The process ID's file path.
Warning:
This parameter changes the spamd daemon's process ID filepath. On systems that use the systemd daemon, you must update the PIDFile parameter in the spamd.service definition. If you do not update the PIDFile parameter, the spamd daemon will fail to function because the PID path and the PIDFile parameter will not match.
Example: pidfile=/var/run/spamd.pid
The maximum amount of time that a child process waits before it abandons a TCP connection.
Note:
If the value of this parameter is 0, child processes will not abandon TCP connections.
Example: timeoutchild=300
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/save_spamd_config
- A server running WHM.
https://whm-server.tld:2087/json-api/save_spamd_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/save_spamd_config?allowedips=127.0.0.1%2C192.168.0.1&maxchildren=5&maxconnperchild=200&pidfile=%2Fvar%2Frun%2Fspamd.pid&timeoutchild=300&timeouttcp=30'Response
application/json
{ "metadata": { "command": "save_spamd_config", "reason": "OK", "result": 1, "version": 1 } }