Start background MySQL upgrade

This function upgrades MySQL® or MariaDB® in the background. This will reinstall MySQL® or MariaDB® if the version given is the installed version.

Important:

When you disable the MySQL/MariaDB server role and remote MySQL® is not already configured, the system disables this function.

SecurityBasicAuth
Request
query Parameters
version
required
number

The desired MySQL® or MariaDB® version. Must contain one decimal.

Example: version=5.7
Responses
200

HTTP Request was successful.

Response Schema: application/json
object
object
get/start_background_mysql_upgrade
Request samples
whmapi1 --output=jsonpretty \
  start_background_mysql_upgrade \
  version='5.7'
Response samples
application/json
{
  • "data": {
    • "upgrade_id": "mysql_upgrade.20200202-172923"
    },
  • "metadata": {
    • "command": "start_background_mysql_upgrade",
    • "reason": "OK",
    • "result": 1,
    • "version": 1
    }
}