- Created by Documentation, last modified on Apr 09, 2018
disable_authentication_provider
disable_failing_authentication_providers
enable_authentication_provider
get_available_authentication_providers
get_provider_client_configurations
get_provider_configuration_fields
get_provider_display_configurations
get_users_authn_linked_accounts
set_provider_client_configurations
set_provider_display_configurations
twofactorauth_generate_tfa_config
twofactorauth_get_user_configs
cpgreylist_is_server_netblock_trusted
cpgreylist_list_entries_for_common_mail_provider
cpgreylist_load_common_mail_providers_config
cpgreylist_save_common_mail_providers_config
cpgreylist_trust_entries_for_common_mail_provider
cpgreylist_untrust_entries_for_common_mail_provider
create_cpgreylist_trusted_host
delete_cpgreylist_trusted_host
Description
This function lists the authenticated user's feature lists.
Notes:
- The
root
account returns all feature lists on the server. - Resellers only return feature lists that the account owns.
Examples
https://hostname.example.com:2087/cpsess##########/json-api/read_featurelist?api.version=1&featurelist=BoomBoomMancini
https://hostname.example.com:2087/cpsess##########/xml-api/read_featurelist?api.version=1&featurelist=BoomBoomMancini
whmapi1 read_featurelist featurelist=BoomBoomMancini
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
{ "data": { "features": { ... "postgres": "0", "popaccts": "1", ... "style": "0", "webmail": "1", ... "analog": "0", "changemx": "1", ... }, "featurelist": "BoomBoomMancini" }, "metadata": { "version": 1, "reason": "OK", "result": 1, "command": "read_featurelist" } }
<result> <data> <features> ... <postgres>0</postgres> <popaccts>1</popaccts> ... <style>0</style> <webmail>1</webmail> ... <analog>0</analog> <changemx>1</changemx> ... </features> <featurelist>BoomBoomMancini</featurelist> </data> <metadata> <version>1</version> <reason>OK</reason> <result>1</result> <command>read_featurelist</command> </metadata> </result>
Note:
Parameters
Parameter | Type | Description | Possible values | Example |
---|---|---|---|---|
| string | Required The feature list's name. | A valid string. | default |
Returns
Return | Type | Description | Possible values | Example |
---|---|---|---|---|
features | hash | A hash of available features in the list. | This hash includes the feature parameter. | |
| Boolean | Whether the feature exists in the feature list. Note: The feature name's is the return's name. The function returns this value in the |
| 1 |
| string | The feature list's name. | A valid string. | BoomBoomMancini |
Function information
API Version:
Available in:
WHM 11.32 - 11.52
Warning:
We deprecated this function in cPanel & WHM version 11.52. Use the get_featurelists
function instead.
Methods:
GET, POST
Required Parameters:
featurelist
Return Formats:
About WHM API 1
WHM API 1 performs functions and accesses data in WHM.
Notes:
- Some functions and parameters may require that you authenticate as the
root
user. - You must use the appropriate WHM ports (
2086
or2087
) to call WHM API functions.
Find a function
Related functions
-
Page:WHM API 1 Functions - getfeaturelist — This function lists features that are available to the authenticated user.
-
Page:WHM API 1 Functions - delete_featurelist — This function deletes a feature list.
-
Page:WHM API 1 Functions - get_available_featurelists — This function lists the authenticated user's available feature lists.
-
Page:WHM API 1 Functions - read_featurelist — This function lists the authenticated user's feature lists.
-
Page:WHM API 1 Functions - update_featurelist — This function creates or updates a feature list.