Description

This function changes a MySQL® database's name.


Examples 




https://hostname.example.com:2087/cpsess##########/json-api/rename_mysql_database?api.version=1&oldname=database&newname=database2&cpuser=example




https://hostname.example.com:2087/cpsess##########/xml-api/rename_mysql_database?api.version=1&oldname=database&newname=database2&cpuser=example




whmapi1 rename_mysql_database oldname=database newname=database2 cpuser=example



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




<result>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>rename_mysql_database</command>
    </metadata>
</result>



Parameters

ParameterTypeDescriptionPossible valuesExample
oldnamestring

Required

The database's current name.

A valid database name. database

newname

string

Required

The database's new name.

A valid database name.

  • 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.


database2

cpuser

string

The database's owner.

A valid username.username

Returns

This function only returns metadata.

This function's metadata includes the payload_is_literal return. For more information, read our WHM API 1 - Return Data documentation.