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

Description

This function changes a PostgreSQL® database user's password.

Important:

In cPanel & WHM version 76 and later, when you disable the Postgres role, the system disables this function. For more information, read our How to Use Server Profiles documentation.

Examples 


 JSON API
/json-api/set_postgresql_password?api.version=1&user=username&password=12345luggage&cpuser=example
 XML API
/xml-api/set_postgresql_password?api.version=1&user=username&password=12345luggage&cpuser=example
 Command Line
whmapi1 set_postgresql_password user=username password=12345luggage cpuser=example


Notes:

  • 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": "set_postgresql_password"
  }
}
 Output (XML)
<result>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>set_postgresql_password</command>
    </metadata>
</result>


Note:

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

Parameters

Parameter
Type
Description
Possible values
Example
userstring

Required

The account's username.

A valid database username.

username
passwordstring

Required

The database user's new password.

A valid  password.12345luggage
cpuserstringThe database user's owner.A valid username.example

Returns

This function only returns metadata.