latestOpenAPI 3.0.2cPanel License2026-08-106251554.3 MB

3da41671c02c

Databases
PostgreSQL Databases

Update PostgreSQL username

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

Important:

When you disable the PostgreSQL role, the system disables this function.

get/rename_postgresql_user

Query parameters

newnamestring required
Example:username2

The database user's new name.

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

oldnamestring username required
Example:username

The database user's current name.

passwordstring required
Example:12345luggage

The database user's new password.

cpuserstring
Example:example

The database user's owner.

Response

HTTP Request was successful.

Example response

{
  "metadata": {
    "command": "rename_postgresql_user",
    "reason": "OK",
    "result": 1,
    "version": 1
  }
}