UAPI Functions - Postgresql::rename_user - Knowledgebase

Description

This function renames a PostgreSQL® database user.

Examples

cPanel or Webmail Session URL

https://hostname.example.com:2083/cpsess##########/execute/Postgresql/rename_user?oldname=dbuser&newname=dbuser2&password=12345luggage

 LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// Renames database user "dbuser" into "dbuser2" with password "12345luggage"
$rename_user = $cpanel->uapi(
    'Postgresql', 'rename_user',
    array(
        'oldname'  => 'dbuser',
        'newname'  => 'dbuser2',
        'password' => '12345luggage',
          )
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Renames database user "dbuser" into "dbuser2" with password "12345luggage"
my $rename_user = $cpliveapi->uapi(
    'Postgresql', 'rename_user',
    {
        'oldname'    => 'database',
        'newname'    => 'database2',
        'password'   => '12345luggage',
    }
);

cPanel Template Toolkit

[% data = execute( 'Postgresql', 'rename_user', { oldname => 'dbuser', newname => 'dbuser2', password => '12345luggage'} ); %]

Command Line

uapi --user=username Postgresql rename_user oldname=dbuser newname-dbuser2 password=12345luggage

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 database user's current name.	A valid string. Note: If database prefixing is enabled, this parameter must include the database prefix for the account.	dbuser
newname	string	Required The database user's new name.	A valid string. Note: If database prefixing is enabled, this parameter must include the database prefix for the account.	dbuser2
password	string	Required The database user's new password.	A secure password.	12345luggage

Returns

This function only returns metadata.

Knowledgebase

Categories

Categories