WHM API 1 Functions - rename_mysql_user

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:

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_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

Parameter Type Description Possible values Example

oldname

string

Required

The database user's current name.

A valid username.

Important:

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

MySQL 5.6

MySQL version 5.6 limits the database username to 16 characters. The server uses the first nine characters of this limit for the database prefix. The database prefix uses the cPanel account's username and an underscore (_). The server only applies the first eight characters of the cPanel account's username.

For example:

A db_ database prefix allows MySQL usernames of up to 13 characters.
An example_ database prefix allows MySQL usernames of up to eight characters.

MySQL 5.7+

MySQL versions 5.7 and later limit the database username to 32 characters. The server uses the first nine characters of this limit for the database prefix. The database prefix uses the cPanel account's username and an underscore (_). The server only applies the first eight characters of the cPanel account's username.

For example:

A db_ database prefix allows MySQL usernames of up to 29 characters.
An example_ database prefix allows MySQL usernames of up to 24 characters.

MariaDB

MariaDB limits the database username to 47 characters. The server uses the first nine characters of this limit for the database prefix. The database prefix uses the cPanel account's username and an underscore (_). The server only applies the first eight characters of the cPanel account's username.

For example:

A db_ database prefix allows MariaDB usernames of up to 44 characters.
An example_ database prefix allows MariaDB usernames of 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

cpuser string The 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.

Function information

API Version:

WHM API 1

Available in:

WHM 11.44+

Methods:

GET, POST

Required Parameters:

oldname,newname

Return Formats:

JSON, XML

Important:

cPanel & WHM version 66 deprecated XML output.

About WHM API 1

WHM API 1 performs functions and accesses data in WHM.

Notes:

Some functions and parameters may require that you authenticate as the root user.
You must use the appropriate WHM ports (2086 or 2087) to call WHM API functions.

Find a function

Related functions

Page:

WHM API 1 Sections - Databases — Database functions allow you to manage your MySQL® and PostgreSQL® database settings.
Page:

WHM API 1 Functions - background_mysql_upgrade_status — This function retrieves the status of a background MySQL® or MariaDB® upgrade.
Page:

WHM API 1 Functions - current_mysql_version — This function retrieves the server's version of MySQL® or MariaDB®.
Page:

WHM API 1 Functions - installable_mysql_versions — This function lists all available versions of MySQL® and MariaDB.
Page:

WHM API 1 Functions - latest_available_mysql_version — This function retrieves the latest available version of MySQL® or MariaDB®.

Child pages

WHM API 1 Functions - rename_mysql_user

Description

Examples

Parameters

Returns

Function information

About WHM API 1

Find a function

Related functions