Child pages
  • cPanel API 2 Functions - MysqlFE::setdbuserprivileges
Skip to end of metadata
Go to start of metadata

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:

Important:

In cPanel & WHM version 76 and later, when you disable the MySQL role, the system disables this function. For more information, read our How to Use Server Profiles documentation.

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


Note:

 For more information, read our Calls from the WHM API documentation.

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


Note:

For more information, read our Guide to the LiveAPI System.

 

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


Note:

For more information, read our Guide to the LiveAPI System.

 

 cPanel Tag System (deprecated)


Warnings:

  • 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. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.
  • cPanel API 2 calls that use cPanel tags vary in code syntax and in their output.
  • For more information, read our Deprecated cPanel Tag Usage documentation.

 Command Line
cpapi2 --user=username MysqlFE setdbuserprivileges privileges=UPDATE%2CALTER db=example_db1 dbuser=example_user1


Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • You must run the --user=username command.
  • For more information and additional output options, read our Guide to cPanel API 2 documentation or run the cpapi2 --help command.
  • If you run CloudLinux™, you must use the full path of the cpapi2 command:

    /usr/local/cpanel/bin/cpapi2

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


Note:

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

Parameters

ParameterTypeDescriptionPossible valuesExample
privilegesstring

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

Required

The database name.

A valid database name.
example_db1
dbuserstring

Required

The database username.

A valid database username.
example_user1

Returns

ReturnTypeDescriptionPossible valuesExample
reasonstring

A reason for failure.

Note:

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