Child pages
  • UAPI Functions - Postgresql::rename_user
Skip to end of metadata
Go to start of metadata

Description

This function renames a PostgreSQL® database user.

Important:

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

Examples


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


Note:

This example calls the UAPI function via a cPanel session. For more information, read our Guide to UAPI documentation. 

 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',
          )
);


Note:

For more information, read our Guide to the LiveAPI System.

 

 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',
    }
);


Note:

For more information, read our Guide to the LiveAPI System.

 

 cPanel Template Toolkit
<!-- Renames database user "dbuser" into "dbuser2" with password "12345luggage" -->
[% data = execute( 'Postgresql', 'rename_user', { oldname => 'dbuser', newname => 'dbuser2', password => '12345luggage'} ); %]


Note:

For more information, read our Guide to Template Toolkit documentation. 

 

 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.
  • For more information and additional output options, read our Guide to UAPI documentation or run the uapi --help command. 
  • If you run CloudLinux™, you must use the full path of the uapi command:

    /usr/local/cpanel/bin/uapi


 Output (JSON)
{
  "messages": null,
  "errors": null,
  "status": 1,
  "metadata": {
     
  },
  "data": null
}


Note:

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

Parameters

ParameterTypeDescriptionPossible valuesExample
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
newnamestring

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
passwordstring

Required

The database user's new password.

A secure password.12345luggage

Returns

This function only returns metadata.