You can find our user documentation at docs.cpanel.net.

Check out our new API beta site!

Child pages
  • WHM API 1 Functions - background_mysql_upgrade_checker_run
Skip to end of metadata
Go to start of metadata

Description

This function checks your MySQL configuration file and table engine before an upgrade to MySQL 8.0.

Important:

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/background_mysql_upgrade_checker_run?api.version=1
 Command Line
whmapi1 background_mysql_upgrade_checker_run


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": {
    "log_entry":"mysql_upgrade_checker_1584025342_24833",
    "pid": 23456
  },
  "metadata": {
    "version": 1,
    "reason": "OK",
    "result": "1",
    "command": "background_mysql_upgrade_checker_run"
  }
}


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

ReturnTypeDescriptionPossible valuesExample
log_entrystring

The upgrade log's location.

A valid file path, relative to the /var/cpanel/logs/ directory.mysql_upgrade.20200202-172923
pid stringThe upgrade check's process ID.A positive integer.23456