cPanel API 2 Functions - MysqlFE::getdbusers

Warning:

The cPanel API 2 system is deprecated. We strongly recommend that you use UAPI instead of cPanel API 2.

Description

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

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=getdbusers&db=example_database

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.

// List database users with permissions to "example_database"
$permissions_database = $cpanel->api2(
    'MysqlFE', 'getdbusers',
    array(
        'db' => 'example_database',
 )
);

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.

# List database users with permissions to "example_database"
my $permissions_database = $cpliveapi->api2(
    'MysqlFE', 'getdbusers',
    {
        'db' => 'example_database',
    }
);

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 getdbusers db=example_database

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": [
      "example_username"
    ],
    "func": "getdbusers",
    "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

Parameter	Type	Description	Possible values	Example
`db`	string	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.	`example_database`

db

string

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.

example_database

Returns

Return Type Description Possible values Example

Return	Type	Description	Possible values	Example
	array	A list of authorized database users.	One or more valid database usernames.	`example_username`
`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`

array

A list of authorized database users.

One or more valid database usernames.

example_username

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