The cPanel API 2 system is deprecated. We strongly recommend that you use UAPI instead of cPanel API 2.
This function lists the databases for which a user has authorization.
We strongly recommend that you use UAPI instead of cPanel API 2. However, no equivalent UAPI function exists.
When you disable the MySQL/MariaDB role and remote MySQL is not already configured, the system disables this function.
https://hostname.example.com:2087/cpsess###########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=MysqlFE&cpanel_jsonapi_func=getalldbusersanddbsFor more information, read our Calls from the WHM API documentation.
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
// Retrieve all information about database users and databases that they are authorized to use
$get_dbinfo = $cpanel->api2(
'MysqlFE', 'getalldbusersanddbs'
);For more information, read our Guide to the LiveAPI System.
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
# Retrieve all information about database users and databases that they are authorized to use
my $get_dbinfo = $cpliveapi->api2(
'MysqlFE', 'getalldbusersanddbs',
);For more information, read our Guide to the LiveAPI System.
- 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.
cpapi2 --user=username MysqlFE getalldbusersanddbs- You must URI-encode values.
usernamerepresents your account-level username.- If you run this command as the
rootuser, you must include the--user=usernameoption. - For more information and additional output options, read our Guide to cPanel API 2 documentation or run the
cpapi2 --helpcommand. - If you run CloudLinux™, you must use the full path of the
cpapi2command:syntaxhighlighter-pre/usr/local/cpanel/bin/cpapi2
{
"cpanelresult": {
"apiversion": 2,
"data": [
{
"dbuser": "cpses_ex24NqG8AX",
"dbs": [
]
},
{
"dbuser": "cpses_exbO3uMNZD",
"dbs": [
]
},
{
"dbuser": "example_bobby",
"dbs": [
]
},
{
"dbuser": "example_fred",
"dbs": [
"example_fred"
]
},
{
"dbuser": "example_username",
"dbs": [
"example_test"
]
}
],
"func": "getalldbusersanddbs",
"event": {
"result": 1
},
"module": "MysqlFE"
}
}Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.
This function does not accept parameters.
| Return | Type | Description | Possible values | Example |
|---|---|---|---|---|
| array of hashes | An array of hashes that contain information about a database user and the user's authorized databases. | Each hash contains the dbuser and dbs returns. | ||
dbuser | string | The database user's name. The function returns this value in the unnamed hash. | A valid username. | example_user1 |
dbs | array | A list of the user's authorized databases. The function returns this value in the unnamed hash. | A valid database name or names. | example_database |
reason | string | A reason for failure. This function only returns a | A string that describes the error. | This is an error message. |
result | Boolean | Whether the function succeeded. |
| 1 |