We have a new documentation site for cPanel & WHM! You can find our new documentation site at docs.cpanel.net.

We will continue to maintain our API documentation on this server.

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

Description

This function changes a PostgreSQL® database user's password.

Important:

In cPanel & WHM version 76 and later, when you disable the PostgreSQL role, the system disables this function.

Examples 


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Postgresql/set_password?user=dbuser&password=123456luggage


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.
 
// Change the PostgreSQL database user "dbuser" password to "123456luggage"
$set_password = $cpanel->uapi(
    'Postgresql', 'set_password',
    array(
        'user'    => 'dbuser',
        'password'=> '123456luggage',
         )
);


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.
 
# Change the PostgreSQL database user "dbuser" password to "12345luggage"
my $set_password = $cpliveapi->uapi(
    'Postgresql', 'set_password',
    {
        'user'    => 'dbuser',
        'password'=> '123456luggage',
    }
);


Note:

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


 Command Line
uapi --user=username Postgresql set_password user=dbuser password=123456luggage


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
user
string

Required

The database user's name.

A valid string.

Note:

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

dbuser
passwordstring

Required

The user's new password.

A secure password.12345luggage

Returns

This function only returns metadata.