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

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

 

Description

This function changes a MySQL® database's name. 

Unable to render {include} The included page could not be found.

Examples 


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/rename_mysql_database?api.version=1&oldname=database&newname=database2&cpuser=example
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/rename_mysql_database?api.version=1&oldname=database&newname=database2&cpuser=example
 Command Line
whmapi1 rename_mysql_database oldname=database newname=database2 cpuser=example


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)
{
  "metadata": {
    "version": 1,
    "reason": "OK",
    "result": "1",
    "command": "rename_mysql_database"
  }
}
 Output (XML)
<result>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>rename_mysql_database</command>
    </metadata>
</result>


Note:

Use WHM's API Shell interface (WHM >> Home >> Development >> API Shell) to directly test WHM API calls.

   

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.

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

cpuser

string

The database's owner.

A valid username.username

Returns

This function only returns metadata.

Note:

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

 

 

  • No labels