- 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 checks whether your server uses the latest version of cPanel & WHM for your release tier.
Examples
https://hostname.example.com:2087/cpsess##########/json-api/get_update_availability?api.version=1
https://hostname.example.com:2087/cpsess##########/xml-api/get_update_availability?api.version=1
whmapi1 get_update_availability
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
{ "metadata":{ "command":"get_update_availability", "result":1, "version":1, "reason":"OK" }, "data":{ "current_version":"56.0.12", "tier":"current", "update_available":0, "newest_version":"56.0.12" } }
<result> <metadata> <version>1</version> <result>1</result> <reason>OK</reason> <command>get_update_availability</command> </metadata> <data> <current_version>56.0.12</current_version> <update_available>0</update_available> <tier>current</tier> <newest_version>56.0.12</newest_version> </data> </result>
Note:
Parameters
This function does not accept parameters.
Returns
Return | Type | Description | Possible values | Example |
---|---|---|---|---|
current_version | string | The server's current version of cPanel & WHM. | A valid cPanel & WHM version number. | 56.0.12 |
update_available | Boolean | Whether a new version of cPanel & WHM is available for the server's support tier. |
| 0 |
tier | string | The server's support tier. |
| current |
newest_version | string | The available version of cPanel & WHM available for the server's support tier. | A valid cPanel & WHM version number. | 56.0.12 |
Function information
API Version:
Available in:
WHM 56+
Methods:
GET, POST
Required Parameters:
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 - get_available_tiers — This function lists of each available version of cPanel & WHM, and each version's latest maintenance release.
-
Page:WHM API 1 Functions - getlongtermsupport — This function retrieves the server's current version's cPanel & WHM Long-Term Support version number.
-
Page:WHM API 1 Functions - set_cpanel_updates — This function sets the frequency of cPanel & WHM updates.
-
Page:WHM API 1 Functions - set_tier — This function sets a cPanel & WHM server to a specified support tier.
-
Page:WHM API 1 Functions - version — This function returns the cPanel & WHM version that a server runs.