# cPanel API 2 Functions - Postgres::listdbs

Warning:
The cPanel API 2 system is deprecated. We **strongly** recommend that you use [UAPI](/cpanel/introduction) 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](/cpanel/introduction/) function
instead of this function:

- [`Postgresql::list_databases`](/specifications/cpanel.openapi/postgresql-database-management/postgresql-list_databases) — This function lists an account's PostgreSQL® databases.


Important:
When you disable the [*PostgreSQL* role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles), the system **disables** this function.

## Examples

WHM API (JSON)


```undefined syntaxhighlighter-pre
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](/whm/use-whm-api-to-call-cpanel-api-and-uapi) documentation.

LiveAPI PHP Class


```undefined syntaxhighlighter-pre
$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](/guides/guide-to-the-liveapi-system/#guide-to-the-liveapi-system).

LiveAPI Perl Module


```undefined syntaxhighlighter-pre
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](/guides/guide-to-the-liveapi-system/#guide-to-the-liveapi-system).

cPanel Tag System (deprecated)

Warnings:
- cPanel tags are **deprecated**. We **strongly** recommend that you **only** use the [LiveAPI](/guides/guide-to-the-liveapi-system) 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](/guides/guide-to-the-liveapi-system).
- 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](/cpanel-api-2/cpanel-api-2-deprecate-cpanel-tag-usage/) documentation.


Command Line


```undefined syntaxhighlighter-pre
cpapi2 --user=username Postgres listdbs
```

div
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](/cpanel-api-2/) documentation or run the `cpapi2 --help` command.
- If you run CloudLinux™, you **must** use the full path of the `cpapi2` command:

```undefined syntaxhighlighter-pre
/usr/local/cpanel/bin/cpapi2
```


br
Output (JSON)


```undefined syntaxhighlighter-pre
{
  "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](https://docs.cpanel.net/cpanel/advanced/api-shell-for-cpanel)* interface (*cPanel >> Home >> Advanced >> API Shell*) to directly test cPanel API calls.

## Parameters

This function does not accept parameters.

## Returns

table
thead
tr
th
strong
Return
th
strong
Type
th
strong
Description
th
strong
Possible values
th
strong
Example
tbody
tr
td
code
sizemeg
td
em
integer
td
p
The size of the database.
td
A real number that represents the size of the database, measured in megabytes (MB).
td
code
                 5.17
tr
td
code
userlist
td
em
array of hashes
td
An array of hashes of each database and its authorized database users.
td
This array of hashes includes the 
code
db
 and 
code
user
 returns.
td
br
tr
td
code
   db
td
em
string
td
p
The database name.
p
The function returns this value in the 
code
userlist
 hash.
td
A valid string.
td
code
example_pgdb1
tr
td
code
   user
td
em
string
td
p
The database username.
p
The function returns this 
span
value
 in the 
code
userlist
 hash.
td
A valid string.
td
code
example_pguser1
tr
td
code
db
td
em
integer
td
The database name.
td
A valid string.
td
code
example_pgdb1
tr
td
code
usercount
td
em
integer
td
The number of users that can access to the database.
td
An integer.
td
code
1
tr
td
code
size
td
em
integer
td
The size of the database.
td
span
A real number that represents the size of the database, measured in bytes.
td
code
5419008
tr
td
code
reason
td
em
string
td
p
A reason for failure.
p
This function only returns a 
code
reason
 value if it failed.
td
p
A string that describes the error.
td
code
This is an error message.
tr
td
code
result
td
em
Boolean
td
p
Whether the function succeeded.
td
ul
li
code
1
 — The function succeeded.
li
code
0
 — The function failed.
td
code
1