latestOpenAPI 3.0.2cPanel License2026-08-106251554.3 MB

3da41671c02c

Configurations

Return Tweak Settings option's value

This function retrieves values from the /var/cpanel/cpanel.config file and the server's Exim configuration.

get/get_tweaksetting

Query parameters

keystring required
Example:defaultmailaction

The Tweak Settings option.

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

One of the following Tweak Settings module names:

  • Apache
  • Basic
  • Mail
  • Main

Response

HTTP Request was successful.

Example response

{
  "data": {
    "tweaksetting": {
      "key": "defaultmailaction",
      "value": "localuser"
    }
  },
  "metadata": {
    "command": "get_tweaksetting",
    "reason": "OK",
    "result": 1,
    "version": 1
  }
}