Description

This function changes a PostgreSQL® database's name.

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

Examples 


https://hostname.example.com:2087/cpsess##########/json-api/rename_postgresql_database?api.version=1&oldname=database&newname=database2&cpuser=example
https://hostname.example.com:2087/cpsess##########/xml-api/rename_postgresql_database?api.version=1&oldname=database&newname=database2&cpuser=example
whmapi1 rename_postgresql_database oldname=database newname=database2 cpuser=example

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

   

Parameters

ParameterTypeDescriptionPossible valuesExample
oldnamestring

Required

The database's current name.

A valid database name.database

newname

string

Required

The database's new name.

A valid database name.

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

database2

cpuser

string

The database's owner.

A valid username.username

Returns

This function only returns metadata.