- Created by Documentation, last modified on Mar 27, 2020
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
block_incoming_email_from_country
block_incoming_email_from_domain
expunge_messages_for_mailbox_guid
get_unique_recipient_count_per_sender_for_user
get_unique_sender_recipient_count_per_user
get_user_email_forward_destination
list_blocked_incoming_email_countries
list_blocked_incoming_email_domains
normalize_user_email_configuration
set_user_email_forward_destination
terminate_cpuser_mailbox_sessions
unblock_incoming_email_from_country
unblock_incoming_email_from_domain
configurebackgroundprocesskiller
enable_monitor_all_enabled_services
get_appconfig_application_list
get_application_contact_event_importance
get_application_contact_importance
link_server_node_with_api_token
remove_in_progress_exim_config_edit
set_application_contact_event_importance
set_application_contact_importance
add_autossl_user_excluded_domains
enqueue_deferred_ssl_installations
fetch_ssl_certificates_for_fqdns
get_autossl_pending_queue_for_domain
get_autossl_pending_queue_for_user
get_autossl_problems_for_domain
get_autossl_user_excluded_domains
get_best_ssldomain_for_service
install_service_ssl_certificate
remove_autossl_user_excluded_domains
set_autossl_user_excluded_domains
Description
This function lists the authenticated user's feature lists.
Notes:
- The
rootaccount returns all feature lists on the server. - Resellers only return feature lists that the account owns.
Important:
We deprecated this function in cPanel & WHM version 11.52. Use the get_featurelists function instead.
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:
- Unless otherwise noted, you must URI-encode values.
- For more information and additional output options, read our Guide to WHM API 1 documentation or run the
whmapi1 --helpcommand. If you run CloudLinux™, you must use the full path of the
whmapi1command:/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
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
rootuser. - You must use the appropriate WHM ports (
2086or2087) to call WHM API functions.
Find a function
Related functions
-
Page:WHM API 1 Functions - remove_override_features_for_user — This function removes feature overrides from a cPanel account.
-
Page:WHM API 1 Functions - delete_featurelist — This function deletes a feature list.
-
Page:WHM API 1 Functions - create_featurelist — This function creates or updates a feature list.
-
Page:WHM API 1 Functions - add_override_features_for_user — This function adds feature overrides to a cPanel account.
-
Page:WHM API 1 Functions - get_feature_metadata — This function lists the details of the authenticated user's available feature lists.