Description

This function lists a cPanel account's PostgreSQL® database users.

Examples 


https://hostname.example.com:2087/cpsess###########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=Postgres&cpanel_jsonapi_func=listusers

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Generate a list of Postgres database users on the account
$list_pgusers = $cpanel->api2(
    'Postgres', 'listusers'
);

 

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Generate a list of Postgres database users on the account
my $list_pgusers = $cpliveapi->api2(
    'Postgres', 'listusers'
);

 

cpapi2 --user=username Postgres listusers

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "listusers",
    "data": [
      {
        "dblist": [
          {
            "db": "example_pgdb1",
            "user": "example_pguser1"
          }
        ],
        "user": "example_pguser1"
      },
      {
        "dblist": [
          {
            "db": "example_pgdb2",
            "user": "example_pguser2"
          }
        ],
        "user": "example_pguser2"
      },
      {
        "dblist": [
          {
            "db": "example_pgdb3",
            "user": "example_pguser3"
          }
        ],
        "user": "example_pguser3"
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Postgres"
  }
}

   

Parameters

This function does not accept parameters.

Returns

Return TypeDescriptionPossible valuesExample
dblistarray of hashesAn array of hashes that contains each database and database username.This array of hashes includes the db and user returns. 

db

string

The database name.

The function returns this value in the dblist hash.

A valid string.example_pgdb1

user

string

The database username.

The function returns this value in the dblist hash.

A valid string.example_pguser1
user string The database username.A valid string.example_pguser1
reasonstring

A reason for failure.

This function only returns a reason value if it failed.

A string that describes the error.

This is an error message.
resultBoolean

Whether the function succeeded.

  • 1 — The function succeeded.
  • 0 — The function failed.
1