cPanel API 2 Functions - MysqlFE::getalldbusersanddbs - Knowledgebase

Description

This function lists the databases for which a user has authorization.

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=getalldbusersanddbs

LiveAPI PHP Class

$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'

);

LiveAPI Perl Module

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

);

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.

Command Line

cpapi2 --user=username MysqlFE getalldbusersanddbs

Notes:

You must URI-encode values.
username represents your account-level username.

 Output (JSON)

{
  "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"
  }
}

Note:

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

Parameters

This function does not accept parameters.

Returns

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