cPanel API 2 Functions - Postgres::listdbs - Knowledgebase

Description

This function lists a cPanel account's PostgreSQL® databases.

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=listdbs

LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.

// Generate a list of Postgres databases on the account

$list_pgdatabases = $cpanel->api2(

'Postgres', 'listdbs'

);

LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.

# Generate a list of Postgres databases on the account

my $list_pgdatabases = $cpliveapi->api2(

'Postgres', 'listdbs',

);

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.

Command Line

cpapi2 --user=username Postgres listdbs

Notes:

You must URI-encode values.
username represents your account-level username.

 Output (JSON)

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "listdbs",
    "data": [
      {
        "sizemeg": "5.17",
        "userlist": [
          {
            "db": "example_pgdb1",
            "user": "example_pguser1"
          }
        ],
        "db": "example_pgdb1",
        "usercount": 1,
        "size": "5419008"
      },
      {
        "sizemeg": "5.17",
        "userlist": [
          {
            "db": "example_pgdb2",
            "user": "example_pguser2"
          },
          {
            "db": "example_pgdb2",
            "user": "example_pguser3"
          }
        ],
        "db": "example_pgdb2",
        "usercount": 2,
        "size": "5419008"
      },
      {
        "sizemeg": "5.17",
        "userlist": [
           
        ],
        "db": "example_pgb3",
        "usercount": 0,
        "size": "5419008"
      },
      {
        "sizemeg": "5.17",
        "userlist": [
           
        ],
        "db": "example_pgdb4",
        "usercount": 0,
        "size": "5419008"
      },
      {
        "sizemeg": "5.17",
        "userlist": [
           
        ],
        "db": "example_pgdb5",
        "usercount": 0,
        "size": "5419008"
      }
    ],
    "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
sizemeg	integer	The size of the database.	A real number that represents the size of the database, measured in Megabytes (MB).	5.17
userlist	array of hashes	An array of hashes of each database and its authorized database users.	This array of hashes includes the dband user returns.
db	string	The database name. The function returns this value in the userlist hash.	A valid string.	example_pgdb1
user	string	The database username. The function returns this value in the userlist hash.	A valid string.	example_pguser1
db	integer	The database name.	A valid string.	example_pgdb1
usercount	integer	The number of users that can access to the database.	An integer.	1
size	integer	The size of the database.	A real number that represents the size of the database, measured in bytes.	5419008
reason	string	A reason for failure. Note: This function only returns areason value 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