Update Apache SpamAssassin™ configuration

This function configures your Apache SpamAssassin™ options.

Important:

When you disable the Spam Filter role, the system disables this function.

SecurityBasicAuth
Request
query Parameters
allowedips
string

A comma-separated list of IP addresses to authorize to access the spamd daemon.

Note:

  • If you do not specify a value, the spamd daemon allows connections from any IP address.
  • If you set a value for this parameter, it must include 127.0.0.1 in the list of values so that the chkservd daemon can access the spamd daemon.
Example: allowedips=127.0.0.1,192.168.0.1
maxchildren
integer >= 1

The maximum number of children per spamd process.

Example: maxchildren=5
maxconnperchild
integer >= 1

The maximum number of connections that the spamd daemon allows per child process.

Example: maxconnperchild=200
pidfile
string

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
timeoutchild
integer >= 0

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
timeouttcp
integer >= 0

The maximum amount of time that the spamd daemon waits before it abandons a TCP connection.

Note:

If the value of this parameter is 0, spamd will not abandon TCP connections.

Example: timeouttcp=30
Responses
200

HTTP Request was successful.

Response Schema: application/json
object
get/save_spamd_config
Request samples
whmapi1 --output=jsonpretty \
  save_spamd_config
Response samples
application/json
{
  • "metadata": {
    • "command": "save_spamd_config",
    • "reason": "OK",
    • "result": 1,
    • "version": 1
    }
}