How to configure cPanel & WHM Tweak Settings through command line

Introduction

Many of the cPanel and WHM features are customizable server-wide from the "Tweak Settings" interface in WHM. These values are stored in the cpanel.config file, but changing this file directly will not necessarily change the setting. This article provides the procedure for modifying the settings using the API on the command line.

Procedure

1. Access the server's command line as the 'root' user via SSH or "Terminal" in WHM.
2. Use the set_tweaksetting API function to set the new value for the desired setting.

   whmapi1 set_tweaksetting key=$settingname value=$newvalue

   Please note that "$settingname" and "$newvalue" must be replaced with the name of the module to modify and the new value, respectively.
3. Use the get_tweaksetting API function to verify that the setting was updated.

   whmapi1 get_tweaksetting key=$settingname

   Please note that "$settingname" must be replaced with the name of the modified module.

Additional resources

The cpanel.config File

Update Tweak Settings option

Return Tweak Settings option's value

How to configure cPanel WHM settings using Tweak Settings