Child pages
  • WHM API 1 Functions - rename_postgresql_database
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

 

Description

This function changes a PostgreSQL® database's name.

Warning:

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

Examples 


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


Notes:

  • Unless otherwise noted, you must URI-encode values.
  • For more information and additional output options, read our Guide to WHM API 1 documentation or run the whmapi1 --help command.
  • If you run CloudLinux™, you must use the full path of the whmapi1 command:

    /usr/local/cpanel/bin/whmapi1

 Output (JSON)
{
  "metadata": {
    "version": 1,
    "reason": "OK",
    "result": "1",
    "command": "rename_postgresql_database"
  }
}
 Output (XML)
<result>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>rename_postgresql_database</command>
    </metadata>
</result>


Note:

Use WHM's API Shell interface (WHM >> Home >> Development >> API Shell) to directly test WHM API calls.

   

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.

Warning:

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.

 

  • No labels