Child pages
  • WHM API 1 Functions - configurebackgroundprocesskiller
Skip to end of metadata
Go to start of metadata

 

Description

This function configures the server's background process killer.

Examples


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/configurebackgroundprocesskiller?api.version=1&processes_to_kill=eggdrop&processes_to_kill-0=bnc&processes_to_kill-1=system&trusted_users=example&trusted_users=user
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/configurebackgroundprocesskiller?api.version=1&processes_to_kill=eggdrop&processes_to_kill-0=bnc&processes_to_kill-1=system&trusted_users=example&trusted_users=user
 Command Line
whmapi1 configurebackgroundprocesskiller processes_to_kill=eggdrop processes_to_kill-0=bnc processes_to_kill-1=services trusted_users=example trusted_users=user


Notes:

  • You must URI-encode values.
  • For more information and additional output options, read our Guide to WHM API 1 documentation or run the whmapi1 --help command.
  • If you run CloudLinux™, you must use the full path of the whmapi1 command:

    /usr/local/cpanel/bin/whmapi1

 Output (JSON)
{
  "metadata": {
    "reason": "OK",
    "result": 1,
    "version": 1,
    "command": "configurebackgroundprocesskiller"
  }
}
 Output (XML)
<result>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>configurebackgroundprocesskiller</command>
    </metadata>
</result>


Note:

Use WHM's API Shell interface (WHM >> Home >> Development >> API Shell) to directly test WHM API calls.

Parameters

ParameterTypeDescriptionPossible valuesExample
processes_to_killstring

Required

The processes to kill.

Note:

To enable the background killer for multiple processes, duplicate or increment the parameter name. For example, to kill three processes, use the processes_to_kill parameter three times or use the processes_to_kill, processes_to_kill-0, and processes_to_kill-1 parameters.

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

For example:

  • BitchX
  • bnc
  • eggdrop
  • generic-sniffers
  • guardservices
  • ircd
  • psyBNC
  • ptlink
  • services
eggdop
trusted_usersstring

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, to trust three users, use the trusted_users parameter multiple times or use the trusted_users=0, trusted_users-1, and trusted_users-2 parameters.

A valid username.user

Returns

This function only returns metadata.