cPanel API 2 Functions - MysqlFE::setdbuserprivileges - Knowledgebase

Description

This function grants privileges to a user on a database.

Warning:

We strongly recommend that you use the following UAPI function instead of this function:

Mysql::set_privileges_on_database — This function sets a MySQL® database user's privileges.

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=setdbuserprivileges&db=example_db1&dbuser=example_user1&privileges=UPDATE%2CALTER

 LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// Grant permissions for "example_user1" on "example_db1"
$grant_user = $cpanel->api2(
    'MysqlFE', 'setdbuserprivileges',
    array(
        'privileges' => 'UPDATE,ALTER',
        'db' => 'example_db1',
        'dbuser' => 'example_user1',
  )
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Grant permissions for "example_user1" on "example_db1"
my $grant_user = $cpliveapi->api2(
    'MysqlFE', 'setdbuserprivileges',
    {
        'privileges' => 'UPDATE,ALTER',
        'db' => 'example_db1',
        'dbuser' => 'example_user1',
 }
);

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 setdbuserprivileges privileges=UPDATE%2CALTER db=example_db1 dbuser=example_user1

 Output (JSON)

{
  "cpanelresult": {
    "apiversion": 2,
    "data": [
      1
    ],
    "func": "setdbuserprivileges",
    "event": {
      "result": 1
    },
    "module": "MysqlFE"
  }
}

Note:

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

Parameters

Parameter	Type	Description	Possible values	Example
privileges	string	Required The privileges to grant to the database user. Important: This list replaces, rather than adds to, the existing privilege list.	ALL PRIVILEGES A comma-separated list of one or more of the following individual privileges: ALTER ALTER ROUTINE CREATE CREATE ROUTINE CREATE TEMPORARY TABLES CREATE VIEW DELETE DROP EVENT EXECUTE INDEX INSERT LOCK TABLES REFERENCES SELECT SHOW VIEW TRIGGER UPDATE Note: In browser-based calls, separate multiple values with %2C and replace spaces in privilege names with %20.	"UPDATE,ALTER"
db	string	Required The database name.	A valid database name.	example_db1
dbuser	string	Required The database username.	A valid database username.	example_user1

Returns

Return	Type	Description	Possible values	Example
reason	string	A reason for failure. Note: This function only returns a reasonvalue 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

Return

Type

Description

Possible values

Example

reason

string

A reason for failure.

Note:

This function only returns a reasonvalue 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.

Knowledgebase

Categories

Categories