cPanel API 2 Modules - MysqlFE

Warning:

The cPanel API 2 system is deprecated. We strongly recommend that you use UAPI instead of cPanel API 2.

Introduction

The MysqlFE module manages MySQL® databases, users, and services.

Important:

When you enable a non-Standard Node server profile, the system disables API calls associated with that profile's disabled roles.

Available functions

cPanel API 2 Functions - MysqlFE::authorizehost — This function authorizes a host for remote access to the account's database.
cPanel API 2 Functions - MysqlFE::changedbuserpassword — This function changes a database user's password.
cPanel API 2 Functions - MysqlFE::createdb — This function creates a database.
cPanel API 2 Functions - MysqlFE::createdbuser — This function creates a database user.
cPanel API 2 Functions - MysqlFE::dbuserexists — This function checks whether a database user exists.
cPanel API 2 Functions - MysqlFE::deauthorizehost — This function removes a remote host's authorization.
cPanel API 2 Functions - MysqlFE::deletedb — This function deletes a database.
cPanel API 2 Functions - MysqlFE::deletedbuser — This function deletes a database user.
cPanel API 2 Functions - MysqlFE::getalldbsinfo — This function retrieves information about all of an account's databases.
cPanel API 2 Functions - MysqlFE::getalldbusersanddbs — This function lists the databases for which a user has authorization.
cPanel API 2 Functions - MysqlFE::getdbuserprivileges — This function lists a database user's privileges on a database.
cPanel API 2 Functions - MysqlFE::getdbusers — This function lists MySQL® database users.
cPanel API 2 Functions - MysqlFE::gethosts — This function lists authorized remote hosts for the account's databases.
cPanel API 2 Functions - MysqlFE::getmysqlprivileges — This function lists the account's MySQL® privileges.
cPanel API 2 Functions - MysqlFE::getmysqlserverprivileges — This function lists the MySQL® server's available privileges.
cPanel API 2 Functions - MysqlFE::has_mycnf_for_cpuser — This function checks whether a valid .my.cnf file exists in the account's home directory.
cPanel API 2 Functions - MysqlFE::listdbs — This function lists the account's databases.
cPanel API 2 Functions - MysqlFE::listdbsbackup — This function lists the account's database backups.
cPanel API 2 Functions - MysqlFE::listhosts — This function lists remote MySQL® connection hosts.
cPanel API 2 Functions - MysqlFE::listusers — This function lists an account's MySQL® database users.
cPanel API 2 Functions - MysqlFE::listusersindb — This function lists MySQL® database users that are authorized to use a database.
cPanel API 2 Functions - MysqlFE::revokedbuserprivileges — This function revokes a user's privileges from a database.
cPanel API 2 Functions - MysqlFE::setdbuserprivileges — This function grants privileges to a user on a database.
cPanel API 2 Functions - MysqlFE::userdbprivs — This function lists a user's privileges on a MySQL® database.