latestOpenAPI 3.0.2cPanel License2026-08-106251554.3 MB

3da41671c02c

Server Administration
Services

Update background process stopper

This function configures the server's background process killer.

get/configurebackgroundprocesskiller

Query parameters

processes_to_killstring required

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.

trusted_usersstring
Example:user

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.

Response

HTTP Request was successful.

Example response

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