Description

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

Examples 




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



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

 



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

 




cpapi2 --user=username MysqlFE getalldbsinfo



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



Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample
 array of hashesAn 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
reasonstring

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

Whether the function succeeded.

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