Packages
Feature Access

Return cPanel accounts' feature settings

This function lists the features settings of cPanel accounts.

get/get_users_features_settings

Request

  • Base URL
    https://whm-server.tld:2087/json-api
  • Auth
    HTTP basic

Query parameters

userstring required

The user's username.

Note:

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

featurestring

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.

Response

HTTP Request was successful.

Example response

{
  "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
  }
}

Changes

No recorded changes to this operation across all 5 revisions of this API.