Child pages
  • WHM API 1 Functions - installable_mysql_versions

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description

Excerpt

This function lists all available versions of MySQL® and MariaDB.

Multiexcerpt include
SpaceWithExcerptcom.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@12665
MultiExcerptNameAPIDisabledMySQLRole
PageWithExcerptLIB:_ServerRoleDisabledAPI

Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone


Expand
titleJSON API


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



Expand
titleXML API


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



Expand
titleCommand Line


Code Block
languagebash
whmapi1 installable_mysql_versions

Include Page
LIB:_WHMAPI1CLINote
LIB:_WHMAPI1CLINote


Expand
titleOutput (JSON)


Code Block
languagetext
linenumberstrue
{
  "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"
  }
}



Expand
titleOutput (XML)


Code Block
languagetext
linenumberstrue
<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>


Include Page
LIB:_WHMAPIShellNote
LIB:_WHMAPIShellNote


Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample
versionsarray 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