How to configure cPanel & WHM Tweak Settings through command line

Introduction

Many of the cPanel & WHM features are customizable on a server-wide basis. The 'Tweak Settings' page allows those changes to be made easily. These values are stored in the cpanel.config file but changing this file directly will not necessarily implement the setting change. To do this you will need to utilize the API tool.

This article discusses how those settings can be modified using the API on the command line.

Procedure

To change a specific option from the Tweak Settings group, you will first need to know the module name of the setting that you wish to change. You can find the full list of module key names and the related settings in the following documentation.

The cpanel.config File

Once you have confirmed the module key name for the desired setting, this can be updated using the API command below. Where you would replace MODULE with the setting key name and X with the setting value.

whmapi1 set_tweaksetting key=MODULE value=X

Once you have made the change, you can confirm this applies by checking the active setting with the following API command. In this example you would again change the MODULE with the appropriate key name for the setting being changed.

whmapi1 get_tweaksetting key=MODULE

For additional information regarding these API tools, please see the documentation pages:

WHM API 1 Functions - set_tweaksetting

WHM API 1 Functions - get_tweaksetting

If you are looking for more information on managing these settings through the WHM interface, the following article may be of assistance.

How to configure cPanel WHM settings using Tweak Settings