Child pages
  • WHM API 1 Functions - get_service_config_key
Skip to end of metadata
Go to start of metadata

Description

This function returns a specific configuration key for a service.

Examples


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/get_service_config_key?api.version=1&service=dovecot&key=mail_process_size
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/get_service_config_key?api.version=1&service=dovecot&key=mail_process_size
 Command Line
whmapi1 get_service_config_key service=dovecot key=mail_process_size


Notes:

  • You must URI-encode values.
  • For more information and additional output options, read our Guide to WHM API 1 documentation or run the whmapi1 --help command.
  • If you run CloudLinux™, you must use the full path of the whmapi1 command:

    /usr/local/cpanel/bin/whmapi1

 Output (JSON)
{  
   "data":{  
      "mail_process_size":"256"
   },
   "metadata":{  
      "command":"get_service_config_key",
      "version":1,
      "reason":"OK",
      "result":1
   }
}
 Output (XML)
<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>


Note:

Use WHM's API Shell interface (WHM >> Home >> Development >> API Shell) to directly test WHM API calls.

Parameters

ParameterTypeDescriptionPossible valuesExample
servicestring

Required

The service's name.

A valid cPanel & WHM service name.

Warning:

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.

Note:

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

mail_process_size

Returns

Note:

Each service and key returns a different set of values.

ReturnTypeDescriptionPossible valuesExample
key namevaries

Required

A configuration key's setting.

Note:

The key name is the return's name.

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