Update background process stopper

This function configures the server's background process killer.

SecurityBasicAuth

Request

processes_to_kill

required

string

A process to kill in the /usr/local/cpanel/etc/sym directory.

Note:

To enable the background killer for multiple processes, duplicate or increment the parameter name.

For example, processes_to_kill, processes_to_kill-0, and processes_to_kill-1.

Examples:

Kill multiple processes. processes_to_kill=eggdrop-0, eggdrop-1, eggdrop-2

Kill a single process. processes_to_kill=eggdrop

trusted_users

string

Unaffected users. If you do not specify a value, the function affects all of the users on the server.

Note:

To trust multiple users, duplicate or increment the parameter name.

For example, trusted_users, trusted_users-0, and trusted_users-1.

Example: trusted_users=user

Responses

200

HTTP Request was successful.

object

get/configurebackgroundprocesskiller

Request samples

whmapi1 --output=jsonpretty \
  configurebackgroundprocesskiller \
  processes_to_kill='eggdrop'

Response samples

application/json

{"metadata": {"command": "configurebackgroundprocesskiller",
"reason": "OK",
"result": 1,
"version": 1
}
}