Return cPanel accounts' feature settings

This function lists the features settings of cPanel accounts.

Authorizations:
query Parameters
user
required
string

The user's username.

Note:

To check multiple users, increment the parameter name. For example, user-1, user-2, and user-3.

Examples:
Multiple users.
user=user-1=example1 user-2=example2 user-3=example3
A single user.
user=example
feature
string

The feature's name.

Note:

  • To check multiple features, increment the parameter name. For example, feature-1, feature-2, and feature-3.
  • If you use this parameter, you must enter a feature name, or the function returns an error. If you do not use this parameter, the function returns data for all features on the server.
Examples:
Multiple feature.
feature=feature-1=autossl feature-2=addoncgi feature-3=addondomains
A single feature.
feature=autossl

Responses

Response Schema: application/json
object
object

Request samples

whmapi1 --output=jsonpretty \
  get_users_features_settings \
  user='example'

Response samples

Content type
application/json
{
  • "data": {
    • "users_features_settings": [
      • {
        • "cpuser_setting": 1,
        • "feature": "autossl",
        • "feature_list": "autossl",
        • "feature_list_setting": 1,
        • "user": "example"
        }
      ]
    },
  • "metadata": {
    • "command": "get_users_features_settings",
    • "reason": "OK",
    • "result": 1,
    • "version": 1
    }
}