cPanel API 2 Functions - MysqlFE::getdbusers - Knowledgebase

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.

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

 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',
 ) 
);

 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',
    }
);

cPanel Tag System (deprecated)

Warning:

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.

cPanel API 2 calls that use cPanel tags vary widely in code syntax and in their output. For more information, read our Deprecated cPanel Tag Usage documentation. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.

 Output (JSON)

{
  "cpanelresult": {
    "apiversion": 2,
    "data": [
      "example_username"
    ],
    "func": "getdbusers",
    "event": {
      "result": 1
    },
    "module": "MysqlFE"
  }
}

Note:

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

Parameters

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

Parameter

Type

Description

Possible values

Example

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
	array of strings	A list of usernames that are authorized to use the database	A valid string.	example_username
reason	string	A reason for failure. Note: This function only returns a reasonvalue 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

Knowledgebase

Categories

Categories