Description

This function returns a specific configuration key for a service.


Examples




https://hostname.example.com:2087/cpsess##########/json-api/get_service_config_key?api.version=1&service=dovecot&key=mail_process_size




https://hostname.example.com:2087/cpsess##########/xml-api/get_service_config_key?api.version=1&service=dovecot&key=mail_process_size




whmapi1 get_service_config_key service=dovecot key=mail_process_size



{  
   "data":{  
      "mail_process_size":"256"
   },
   "metadata":{  
      "command":"get_service_config_key",
      "version":1,
      "reason":"OK",
      "result":1
   }
}




<result>
    <data>
        <mail_process_size>256</mail_process_size>
    </data>
    <metadata>
        <reason>OK</reason>
        <version>1</version>
        <result>1</result>
        <command>get_service_config_key</command>
    </metadata>
</result>



Parameters

ParameterTypeDescriptionPossible valuesExample
servicestring

Required

The service's name.

A valid cPanel & WHM service name.

As of cPanel & WHM version 58, only the dovecot service is compatible with this function.


dovecot
keystring

Required

The configuration key's name.

A valid configuration key for the service.

This function currently only supports top-level configuration keys and not subkeys.


mail_process_size

Returns

Each service and key returns a different set of values.


ReturnTypeDescriptionPossible valuesExample
key namevaries

Required

A configuration key's setting.

The key name is the return's name.


This return's possible values depend on the service and key.
256