UAPI Functions - Mysql::rename_user - Knowledgebase

Description

This function renames a MySQL® database user.

Examples

cPanel or Webmail Session URL

https://hostname.example.com:2083/cpsess##########/execute/Mysql/rename_user?oldname=dbuser&newname=mynewusername

 LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// Rename the dbuser user.
$rename_db_user = $cpanel->uapi(
    'Mysql', 'rename_user',
    array(
        'oldname'       => 'dbuser',
        'newname'       => 'mynewusername',
    )
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Rename the dbuser user.
my $rename_db_user = $cpliveapi->uapi(
    'Mysql', 'rename_user',
    {
        'oldname'       => 'dbuser',
        'newname'       => 'mynewusername',
    }
);

cPanel Template Toolkit

[% execute('Mysql', 'rename_user', { oldname => 'dbuser', newname => 'mynewusername' } ) %]

Command Line

uapi --user=username Mysql rename_user oldname=dbuser newname=mynewusername

Notes:

You must URI-encode values.
username represents your account-level username.

Output (JSON)

{

"messages": null,

"errors": null,

"status": 1,

"metadata": {

},

"data": null

Note:

Use cPanel's API Shell interface (Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

Parameter	Type	Description	Possible values	Example
oldname	string	Required The user's current name.	A MySQL database user on the cPanel account.	dbuser
newname	string	Required The user's new name.	A valid MySQL database username. Important: To learn more about database username limits, click the database type to expand the following: MySQL MariaDB Important: If database prefixing is enabled, you must prefix this value with the account prefix and an underscore (_). For example, for the dbuser user on the user cPanel account, pass in a value of user_dbuser.	mynewusername

Parameter

Type

Description

Possible values

Example

oldname

string

Required

The user's current name.

A MySQL database user on the cPanel account.

dbuser

newname

string

Required

The user's new name.

A valid MySQL database username.

Important:

To learn more about database username limits, click the database type to expand the following:

MySQL

MariaDB

Important:

If database prefixing is enabled, you must prefix this value with the account prefix and an underscore (_).

For example, for the dbuser user on the user cPanel account, pass in a value of user_dbuser.

mynewusername

Returns

This function only returns metadata.

Knowledgebase

Categories

Categories