cPanel API 2 Functions - MysqlFE::getalldbsinfo - Knowledgebase

Description

This function retrieves information about all of an account's databases.

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

LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.

// Retrieve all information about the databases and database users

$get_dbinfo = $cpanel->api2(

'MysqlFE', 'getalldbsinfo'

);

LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.

# Retrieve all information about the databases and database users

my $get_dbinfo = $cpliveapi->api2(

'MysqlFE', 'getalldbsinfo',

);

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 getalldbsinfo

Notes:

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

 Output (JSON)

 {
  "cpanelresult": {
    "apiversion": 2,
    "data": [
      {
        "dbusers": [
          "example_fred"
        ],
        "db": "example_freddb",
        "size": "0"
      },
      {
        "dbusers": [
          "example_username"
        ],
        "db": "example_testdb",
        "size": "0"
      },
      {
        "dbusers": [
            
        ],
        "db": "example_walterdb",
        "size": "0"
      }
    ],
    "func": "getalldbsinfo",
    "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 each database.	Each hash contains the `db`and `size` returns and the`dbusers` array.
`dbusers`	array	An array of database users that are authorized to access the database. The function returns this value in the unnamed hash.	One or more valid usernames.	example_user1
`db`	string	The database's name. The function returns this value in the unnamed hash.	A valid database name.	`example_database`
`size`	integer	The size of the database. The function returns this value in the unnamed hash.	An integer that represents the database size, in bytes.	`0`
`reason`	string	A reason for failure. Note: 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`

Knowledgebase

Categories

Categories