Description

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

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

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

 

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

 

cpapi2 --user=username MysqlFE getalldbusersanddbs

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

   

Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample
 array of hashesAn array of hashes that contain information about a database user and the user's authorized databases.Each hash contains the dbuser and dbs returns. 

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