- Created by Documentation, last modified on Apr 09, 2018
Use WHM API to Call cPanel API & UAPI
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 adds feature overrides to a cPanel account.
Examples
https://hostname.example.com:2087/cpsess##########/json-api/add_override_features_for_user?api.version=1&user=example&features=%7B%22videotut%22%3A0%2C%22sslinstall%22%3A1%7D
https://hostname.example.com:2087/cpsess##########/xml-api/add_override_features_for_user?api.version=1&user=example&features=%7B%22videotut%22%3A0%2C%22sslinstall%22%3A1%7D
whmapi1 add_override_features_for_user user=example features=%7B%22videotut%22%3A0%2C%22sslinstall%22%3A1%7D
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. - We introduced this functionality in cPanel & WHM version 11.52.0.8.
{ "metadata":{ "command":"add_override_features_for_user", "version":1, "reason":"OK", "result":1 } }
<result> <metadata> <result>1</result> <version>1</version> <reason>OK</reason> <command>add_override_features_for_user</command> </metadata> </result>
Note:
Parameters
Parameter | Type | Description | Possible values | Example |
---|---|---|---|---|
| string | Required The user's username. | A valid cPanel username. | username |
features | hash | Required A hash that lists features to override and whether to enable or disable them.
| This JSON-encoded hash includes the
| {"videotut":0,"sslinstall":1} |
| Boolean | Required Whether to enable or disable the feature. Note: The feature's name is the parameter's name. The function includes this parameter in the |
| 1 |
Returns
This function only returns metadata.
Function information
API Version:
Available in:
WHM 56+
Methods:
GET, POST
Required Parameters:
user
, features
, feature_name
Return Formats:
About WHM API 1
WHM API 1 performs functions and accesses data in WHM.
Notes:
- Some functions and parameters may require that the 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.