CPcpanel
Configurations

Update Tweak Settings option

This function sets an option's value in WHM's Tweak Settings interface (WHM >> Home >> Server Configuration >> Tweak Settings). The system stores the keys and values that this function updates in the /var/cpanel/cpanel.config file.

get/set_tweaksetting

Request

  • Base URL
    https://whm-server.tld:2087/json-api
  • Auth
    HTTP basic

Query parameters

keystring required
Example:proxysubdomains

The cpanel.config setting name that corresponds to the desired setting in WHM's Tweak Settings interface (WHM >>Home >> Server Configuration >> Tweak Settings).

module'Apache' | 'Basic' | 'Mail' | 'Main'
Example:Main

The Tweak Settings interface section.

Note:

The possible section names are:

  • Apache
  • Basic
  • Mail
  • Main
valuestring
Example:0

The value to assign to the setting. If you include this parameter in the call but do not set a value, the value defaults to an empty value.

Note:

For more information about the requirements for values in the cpanel.config file settings, read our cpanel.config file documentation.

Response

HTTP Request was successful.

Example response

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

Changes

No recorded changes to this operation across all 5 revisions of this API.