Sign in
latestOpenAPI 3.0.2cPanel License2026-08-106251554.3 MB

3da41671c02c

Server Administration
Services

Update service configuration key

This function configures global properties for specific services listed in the /var/cpanel/conf directory.

get/set_service_config_key

Query parameters

keystring required
Example:mail_process_size

The configuration key's name.

  • This parameter uses the key names listed in the /var/cpanel/conf/{service}/main file, where {service} is the service's name from the service parameter.
  • This function does not support subkeys.
servicestring required
Example:dovecot

The service's name.

  • A list of service names exists in the /var/cpanel/conf directory.
string required
OR
integer required

The new value for the configuration key.

Response

HTTP Request was successful.

Example response

{
  "metadata": {
    "command": "set_service_config_key",
    "reason": "Succeeded",
    "result": 1,
    "version": 1
  }
}