Last updated 3 months ago

cPanel API 2 Functions - Postgres::listdbs

Warning:

The cPanel API 2 system is deprecated. We strongly recommend that you use UAPI instead of cPanel API 2.

Description

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

Warning:

We strongly recommend that you use the following UAPI function instead of this function:

Postgresql::list_databases — This function lists an account's PostgreSQL® databases.

Important:

When you disable the PostgreSQL role, the system disables this function.

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

Note:

For more information, read our Calls from the WHM API documentation.

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'
);

Note:

For more information, read our Guide to the LiveAPI System.

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',
);

Note:

For more information, read our Guide to the LiveAPI System.

cPanel Tag System (deprecated)

Warnings:

cPanel tags are deprecated . We strongly recommend that you only use the LiveAPI system to call the cPanel APIs. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI .
cPanel API 2 calls that use cPanel tags vary in code syntax and in their output.
For more information, read our Deprecated cPanel Tag Usage documentation.

Command Line

cpapi2 --user=username Postgres listdbs

Notes:

You must URI-encode values.
username represents your account-level username.
You must include the --user=username option.
For more information and additional output options, read our Guide to cPanel API 2 documentation or run the cpapi2 --help command.
If you run CloudLinux™, you must use the full path of the cpapi2 command:
```
/usr/local/cpanel/bin/cpapi2
```

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 (cPanel >> 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 `db` and `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. This function only returns a `reason` 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`