cPanel WHM icon

cPanel WHM

Full cPanel WHM API — all 622 operations across Accounts, DNS, Mail, SSL, Backups, Databases and more

Actions262

Package → Return cPanel accounts' feature settings

AI-generated

Summary

Retrieve feature settings for one or more specified cPanel user accounts, optionally filtering by one or more feature names.

Inputs

  • User (required) — The username of the cPanel account to query. To retrieve settings for multiple users, increment the parameter name (e.g., user-1, user-2, user-3).
  • Additional Fields — Optional collection to specify one or more features to filter the returned feature settings. To check multiple features, increment the parameter name (e.g., feature-1, feature-2, feature-3). If specified, each feature name must be provided, otherwise an error occurs.

Output shape

an object or list of objects representing the feature settings for the specified user(s), including each requested feature if filtered

The returned data includes feature settings for each provided user. If multiple users or features are specified by incrementing parameter names, the response contains settings accordingly. Errors occur if feature parameters are used without a feature name.

Examples

Example 1: Query features for a single user

Set User to the target username; leave Additional Fields empty to retrieve all features.

Example 2: Query specific features for multiple users

Set multiple User parameters (user-1, user-2, ...) and specify one or more feature parameters (feature-1, feature-2, ...) under Additional Fields to filter returned data.

Links

Discussion