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

Warning:

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

Important:

When you disable the MySQL/MariaDB role and remote MySQL is not already configured, 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=MysqlFE&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.

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

# 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.

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

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 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,
    "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 interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

Parameter	Type	Description	Possible values	Example
`regex`	string	A Perl Compatible Regular Expression (PCRE) that filters the results. The system matches the PCRE to both the database name.	A valid PCRE.	`db=example_*`

Returns

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