- 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
Introduction
Update functions allow you to manage your server's cPanel & WHM version.
Available functions
- WHM API 1 Functions - accept_eula — This function records acceptance of cPanel & WHM's legal terms.
- WHM API 1 Functions - get_available_tiers — This function lists of each available version of cPanel & WHM, and each version's latest maintenance release.
- WHM API 1 Functions - get_current_lts_expiration_status — This function determines whether a branch's Long-Term Support (LTS) version expires within three months.
- WHM API 1 Functions - get_lts_wexpire — This function parses the /etc/cpanel/TIERS.json file and returns whether a branch qualifies for Long-Term Support (LTS).
- WHM API 1 Functions - getlongtermsupport — This function retrieves the server's current version's cPanel & WHM Long-Term Support version number.
- WHM API 1 Functions - installed_versions — This function lists the versions of third-party software that ship with cPanel & WHM.
- WHM API 1 Functions - set_cpanel_updates — This function sets the frequency of cPanel & WHM updates.
- WHM API 1 Functions - set_tier — This function sets a cPanel & WHM server to a specified support tier.
- WHM API 1 Functions - update_updateconf — This function modifies a server's /etc/cpupdate.conf file.
- WHM API 1 Functions - version — This function returns the cPanel & WHM version that a server runs.
WHM API 1 Basics
Available in:
WHM 11+
Languages:
JSON, XML
Methods:
GET, POST
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.
Related Documentation
-
Page:Guide to WHM API 1 — WHM API 1 accesses the WHM interface's features.
-
Page:WHM API 1 - Filter Output — You can use additional variables to filter WHM API 1 output.
-
Page:WHM API 1 - Sort Output — You can use additional variables to sort WHM API 1 output.
-
Page:WHM API 1 - Paginate Output — You can use additional variables to paginate WHM API 1 output.
-
Page:WHM API 1 - Return Data — WHM API 1 outputs data in either JSON or XML format.