v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB
Postgresql
PostgreSQL User Management

Update PostgreSQL username

This function renames a PostgreSQL® database user.

Important:

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

get/Postgresql/rename_user

Query parameters

newnamestring required
Example:dbuser2

The database user's new name.

Note:

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

oldnamestring required
Example:dbuser

The database user's current name.

Note:

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

passwordstring required
Example:123456luggage

The database user's new password.

Response

HTTP Request was successful.

apiversioninteger

The version of the API.

funcstring

The name of the method called.

modulestring

The name of the module called.

Example response

{
  "apiversion": 3,
  "func": "rename_user",
  "module": "Postgresql",
  "result": {
    "status": 1
  }
}