cPanel API 2 Functions - Postgres::listusers - Knowledgebase

Description

This function lists an account's PostgreSQL® database users.

Warning:

We strongly recommend that you use UAPI instead of cPanel API 2. However, no equivalent UAPI function exists.

Examples

WHM API (JSON)

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

LiveAPI PHP Class

$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'

);

LiveAPI Perl Module

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'

);

cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that you only use theLiveAPI system to call the cPanel APIs.

cPanel API 2 calls that use cPanel tags vary widely in code syntax and in their output. For more information, read ourDeprecated cPanel Tag Usage documentation. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.

 Output (JSON)

{
  "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"
  }
}

Note:

Use cPanel's API Shell interface (Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

This function does not accept parameters.

Returns

Return	Type	Description	Possible values	Example
dblist	hash	A hash that contains each database and database username.	This hash includes the db and userparameters.
db	string	The database name. The function returns this parameter in the dblist hash.	A valid string.	example_pgdb1
user	string	The database username. The function returns this parameter in the dblist hash.	A valid string.	example_pguser1
user	string	The database username.	A valid string.	example_pguser1
reason	string	A reason for failure. Note: This function only returns a reasonvalue if it failed.	A string that describes the error.	This is an error message.
result	boolean	Whether the function succeeded.	1 — The function succeeded. 0 — The function failed.	1

Knowledgebase

Categories

Categories