latestOpenAPI 3.0.2cPanel License2026-08-106251554.3 MB

3da41671c02c

Databases
PostgreSQL Databases

Update PostgreSQL database name

This function changes a PostgreSQL® database's name.

Warning:

The system requires more time to rename larger and more complex databases.

Important:

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

get/rename_postgresql_database

Query parameters

newnamestring required
Example:database2

The database's new name.

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

oldnamestring required
Example:database

The database's current name.

cpuserstring username
Example:username

The database's owner.

Response

HTTP Request was successful.

Example response

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