Update MySQL database name

This function changes a MySQL® database's name. MySQL does not allow you to rename a database. When cPanel & WHM "renames" a database, the system performs the following steps:

The system creates a new database.
The system moves data from the old database to the new database.
The system recreates grants and stored code in the new database.
The system deletes the old database and its grants.

Warning:

If any of the first three steps fail, the system returns an error and attempts to restore the database's original state. If the restoration process fails, the API function's error response describes these additional failures.
In rare cases, the system creates the second database successfully but fails to delete the old database or grants. The system treats the rename action as a success; however, the API function returns warnings that describe the failure to delete the old database or grants.

Important:

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

SecurityBasicAuth

Request

query Parameters

newname required	string <= 64 characters The database's new name. Warning: If database prefixing is enabled, this parameter must include the database prefix for the account. The maximum length of the database name is 64 characters. However, due to the method that cPanel & WHM uses to store MySQL database names, each underscore character (_) requires two characters of that limit. Therefore, if you enable database prefixing, the maximum length of the database name is 63 characters, which includes both the database prefix and the underscore character. Each additional underscore requires another two characters of that limit. Example: newname=database2
oldname required	string The database's current name. Example: oldname=database
cpuser	string <username> The database's owner. Example: cpuser=username

Responses

200

HTTP Request was successful.

Response Schema: application/json

object

get/rename_mysql_database

Request samples

whmapi1 --output=jsonpretty \
  rename_mysql_database \
  oldname='database' \
  newname='database2'

Response samples

application/json

{"metadata": {"command": "rename_mysql_database",
"reason": "OK",
"result": 1,
"version": 1
}
}