- Created by Documentation, last modified on Oct 05, 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 all available versions of MySQL® and MariaDB.
Important:
MySQL
role, the system disables this function. For more information, read our How to Use Server Profiles documentation.Examples
https://hostname.example.com:2087/cpsess##########/json-api/installable_mysql_versions?api.version=1
https://hostname.example.com:2087/cpsess##########/xml-api/installable_mysql_versions?api.version=1
whmapi1 installable_mysql_versions
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": { "versions": [ { "version": "5.0", "server": "mysql" }, { "version": "5.1", "server": "mysql" }, { "version": "5.5", "server": "mysql" }, { "version": "5.6", "server": "mysql" }, { "version": "10.0", "server": "mariadb" } ] }, "metadata": { "version": 1, "reason": "OK", "result": 1, "command": "installable_mysql_versions" } }
<result> <data> <versions> <version>5.0</version> <server>mysql</server> </versions> <versions> <version>5.1</version> <server>mysql</server> </versions> <versions> <version>5.5</version> <server>mysql</server> </versions> <versions> <version>5.6</version> <server>mysql</server> </versions> <versions> <version>10.0</version> <server>mariadb</server> </versions> </data> <metadata> <version>1</version> <reason>OK</reason> <result>1</result> <command>installable_mysql_versions</command> </metadata> </result>
Note:
Parameters
This function does not accept parameters.
Returns
Return | Type | Description | Possible values | Example |
---|---|---|---|---|
versions | array of hashes | An array of hashes that contain information about the database version information. | This array of hashes includes data from the version and server returns. | |
| string | The version number. The function returns this value in the | A valid string, in major.minor format. | 10.0 |
| string | The server's database engine. The function returns this value in the |
| mariadb |
Function information
API Version:
Available in:
cPanel 11.48+
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 Sections - Databases — Database functions allow you to manage your MySQL® and PostgreSQL® database settings.
-
Page:WHM API 1 Functions - rename_mysql_database — This function changes a MySQL® database's name.
-
Page:WHM API 1 Functions - rename_mysql_user — This function changes a MySQL® database user's name.
-
Page:WHM API 1 Functions - set_mysql_password — This function changes a MySQL® database user's password.
-
Page:WHM API 1 Functions - installable_mysql_versions — This function lists all available versions of MySQL® and MariaDB.