Our documentation is getting an overhaul! We would like your input! Click here to take a look at the beta launch of our new documentation site! Only cPanel & WHM version 82 documentation exists on our beta at this time. 84 will be added to the new site soon! Leave your feedback here: https://go.cpanel.net/docsfeedback
cPanel API 2 Functions - MysqlFE::getdbusers - Developer Documentation - cPanel Documentation
Child pages
  • cPanel API 2 Functions - MysqlFE::getdbusers
Skip to end of metadata
Go to start of metadata


This function lists MySQL® database users. It can list all users, or only users who can access a specific database.


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


In cPanel & WHM version 76 and later, when you disable the MySQL role, the system disables this function. For more information, read our How to Use Server Profiles documentation.




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

 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
// List database users with permissions to "example_database"
$permissions_database = $cpanel->api2(
    'MysqlFE', 'getdbusers', 
        'db' => 'example_database',


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.
# List database users with permissions to "example_database"
my $permissions_database = $cpliveapi->api2(
    'MysqlFE', 'getdbusers',
        'db' => 'example_database',


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


 cPanel Tag System (deprecated)


  • In cPanel & WHM version 11.30 and later, 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 getdbusers db=example_database


  • You must URI-encode values.
  • username represents your account-level username.
  • You must run the --user=username command.
  • 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:


 Output (JSON)
  "cpanelresult": {
    "apiversion": 2,
    "data": [
    "func": "getdbusers",
    "event": {
      "result": 1
    "module": "MysqlFE"


Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.


ParameterTypeDescriptionPossible valuesExample

The database name.

If you do not specify a value, the function returns a list of all database users on the account.

A valid string.



ReturnTypeDescriptionPossible valuesExample

A list of authorized database users.

One or more valid database usernames.

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.

Whether the function succeeded.

  • 1 — The function succeeded.
  • 0 — The function failed.