UAPI Functions - Mysql::revoke_access_to_database - Knowledgebase

Description

This function revokes a MySQL® database user's privileges.

Examples

cPanel or Webmail Session URL

https://hostname.example.com:2083/cpsess##########/execute/Mysql/revoke_access_to_database?user=dbuser&database=mydb

 LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// Revoke the dbuser user's privileges for the mydb database.
$revoke_dbuser_privs = $cpanel->uapi(
    'Mysql', 'revoke_access_to_database',
    array(
        'user'       => 'dbuser',
        'database'   => 'mydb',
    )
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Revoke the dbuser user's privileges for the mydb database.
my $revoke_dbuser_privs = $cpliveapi->uapi(
    'Mysql', 'revoke_access_to_database',
    {
        'user'       => 'dbuser',
        'database'   => 'mydb',
    }
);

cPanel Template Toolkit

[% execute('Mysql', 'revoke_access_to_database', { user => 'dbuser', database => 'mydb' } ) %]

Command Line

uapi --user=username Mysql revoke_access_to_database user=dbuser database=mydb

Notes:

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

 Output (JSON)

{
  "messages": null,
  "errors": null,
  "status": 1,
  "metadata": {
      
  },
  "data": null
}

Note:

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

Parameters

Parameter	Type	Description	Possible values	Example
user	string	Required The database user's name.	A MySQL user on the cPanel account. Important: If database prefixing is enabled, you must prefix this value with the account prefix and an underscore (_). For example, for the dbuser user on the user cPanel account, pass in a value of user_dbuser.	dbuser
database	string	Required The database's name.	A MySQL database on the cPanel account.	mydb

Parameter

Type

Description

Possible values

Example

user

string

Required

The database user's name.

A MySQL user on the cPanel account.

Important:

If database prefixing is enabled, you must prefix this value with the account prefix and an underscore (_).

For example, for the dbuser user on the user cPanel account, pass in a value of user_dbuser.

dbuser

database

string

Required

The database's name.

A MySQL database on the cPanel account.

mydb

Returns

This function only returns metadata.

Knowledgebase

Categories

Categories