WHM API 1 Functions - installable_mysql_versions

In cPanel & WHM version 76 and later, when you disable the MySQL/MariaDB role and remote MySQL is not already configured, the system disables this function.

Examples

JSON API

https://hostname.example.com:2087/cpsess##########/json-api/installable_mysql_versions?api.version=1

XML API

https://hostname.example.com:2087/cpsess##########/xml-api/installable_mysql_versions?api.version=1

Command Line

whmapi1 installable_mysql_versions

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 --help command.
If you run CloudLinux™, you must use the full path of the whmapi1 command:
```
/usr/local/cpanel/bin/whmapi1
```

Output (JSON)

{
  "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"
  }
}

Output (XML)

<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:

Use WHM's API Shell interface (WHM >> Home >> Development >> API Shell) to directly test WHM API calls.

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.

version

string

The version number.

The function returns this value in the versions hash.

A valid string, in major.minor format.

10.0

server

string

The server's database engine.

The function returns this value in the versions hash.

mysql
mariadb

mariadb

Function information

API Version:

WHM API 1

Available in:

cPanel 11.48+

Methods:

GET, POST

Required Parameters:

(none)

Return Formats:

JSON, XML

Important:

cPanel & WHM version 66 deprecated XML output.

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 or 2087) to call WHM API functions.

Find a function

Related functions

Page:

WHM API 1 Functions - set_postgresql_password — This function changes a PostgreSQL® database user's password.
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 Sections - Databases — Database functions allow you to manage your MySQL® and PostgreSQL® database settings.
Page:

WHM API 1 Functions - background_mysql_upgrade_status — This function retrieves the status of a background MySQL® or MariaDB® upgrade.

Child pages