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

Description

This function changes a MySQL® database user's name.

Important:

In cPanel & WHM version 76 and later, when you disable the MySQL role, the system disables this function. For more information, read our How to Use Server Profiles documentation.

Examples 


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


Notes:

  • 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_user"
  }
}
 Output (XML)
<result>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>rename_mysql_user</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 user's current name.

A valid username.

Important:

To learn more about database username limits, click your database type:

 MySQL

MySQL limits the database username to 16 characters. The system includes the database prefix (the first eight characters of the cPanel account's username and an underscore character) in the character count for the username.

For example:

  • A MySQL database with the db_ prefix allows usernames that contain up to 13 characters.
  • A MySQL database with the example_ prefix allows usernames that contain up to eight characters.
 MariaDB

MariaDB limits the database username to 47 characters. The system includes the database prefix (all of the cPanel account's username and an underscore character) in the character count for the username.

For example:

  • A MariaDB database with the db_ prefix allows usernames that contain up to 44 characters.
  • A MariaDB database with the example_ prefix allows usernames that contain up to 39 characters.

 username

newname

string

Required

The database user's new name.

A valid username.

Warning

If database prefix is enabled, this parameter must include the database prefix for the account.

username2
cpuserstringThe database user's owner.A valid username.example

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.