# cPanel API 2 Functions - MysqlFE::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 the account's databases.

Warning:
We **strongly** recommend that you use [UAPI](/cpanel/introduction/) instead of cPanel API 2. However, no equivalent UAPI function exists.

Important:
When you disable the [*MySQL/MariaDB* role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles) **and** remote MySQL is **not** already configured, 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=MysqlFE&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.

// Check for a valid .my.cnf file
$list_database = $cpanel->api2(
    'MysqlFE', '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.

# Check for a valid .my.cnf file
my $list_database = $cpliveapi->api2(
    'MysqlFE', 'listdbs',
);
```

Note:
For more information, read our [Guide to the LiveAPI System](/guides/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 MysqlFE listdbs
```

div
Notes:

- You **must** URI-encode values.
- `username` represents your account-level username.
- If you run this command as the `root` user, 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,
    "data": [
      {
        "userlist": [
          {
            "db": "example_fred",
            "user": "example_fred"
          }
        ],
        "sizemeg": "0.00",
        "db": "example_fred",
        "size": "0",
        "usercount": 1
      },
      {
        "userlist": [
          {
            "db": "example_test",
            "user": "example_username"
          }
        ],
        "sizemeg": "0.00",
        "db": "example_test",
        "size": "0",
        "usercount": 1
      },
      {
        "userlist": [

        ],
        "sizemeg": "0.00",
        "db": "example_walter",
        "size": "0",
        "usercount": 0
      }
    ],
    "func": "listdbs",
    "event": {
      "result": 1
    },
    "module": "MysqlFE"
  }
}
```

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

table
thead
tr
th
strong
Parameter
th
strong
Type
th
strong
Description
th
strong
Possible values
th
strong
Example
tbody
tr
td
code
regex
td
em
string
td
p
A 
a
Perl Compatible Regular Expression (PCRE)
 that filters the results. The system matches the PCRE to both the database name.
td
A valid PCRE.
td
code
db=example_*
## Returns

table
thead
tr
th
strong
strong
Return
th
strong
Type
th
strong
Description
th
strong
Possible values
th
strong
Example
tbody
tr
td
code
userlist
td
em
hash
td
A hash that contains information about a database and the authorized users.
td
A hash that 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 database name.
td
code
example_database
tr
td
code
user
td
em
string
td
p
An authorized username.
p
The function returns this value in the 
code
userlist
 hash.
td
A valid database user name.
td
code
example_user1
tr
td
code
sizemeg
td
em
string
td
The database's size.
td
A real number, in megabytes (MB).
td
code
0.00
tr
td
code
db
td
em
string
td
The database name.
td
A valid database name.
td
code
example_database
tr
td
code
usercount
td
em
integer
td
The number of users that are authorized to use the database.
td
A valid positive integer.
td
code
1
tr
td
code
size
td
em
integer
td
The database's size.
td
A valid integer, in bytes.
td
code
0
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
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