Child pages
  • WHM API 1 Functions - rename_postgresql_database

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description

Excerpt

This function changes a PostgreSQL® database's name.


Warning
titleWarning:

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

Multiexcerpt include
SpaceWithExcerptcom.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@12665
MultiExcerptNameAPIDisabledPostgresRole
PageWithExcerptLIB:_ServerRoleDisabledAPI

Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone


Expand
titleJSON API


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



Expand
titleXML API


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



Expand
titleCommand Line


Code Block
languagebash
whmapi1 rename_postgresql_database oldname=database newname=database2 cpuser=example

Include Page
LIB:_WHMAPI1CLINote
LIB:_WHMAPI1CLINote


Expand
titleOutput (JSON)


Code Block
languagetext
linenumberstrue
{
  "metadata": {
    "version": 1,
    "reason": "OK",
    "result": "1",
    "command": "rename_postgresql_database"
  }
}



Expand
titleOutput (XML)


Code Block
languagetext
linenumberstrue
<result>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>rename_postgresql_database</command>
    </metadata>
</result>


Include Page
LIB:_WHMAPIShellNote
LIB:_WHMAPIShellNote


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
titleWarning:

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.