# cPanel API 2 Functions - MysqlFE::getmysqlserverprivileges

Warning:
The cPanel API 2 system is deprecated. We **strongly** recommend that you use [UAPI](/cpanel/introduction) instead of cPanel API 2.

## Description

This function lists the MySQL® server's available privileges.

Warning:
We **strongly** recommend that you use [UAPI](/cpanel/introduction/) instead of cPanel API 2. However, no equivalent UAPI function exists.

Important:
When you disable the [*MySQL/MariaDB* role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles) **and** remote MySQL is **not** already configured, the system **disables** this function.

## Examples

### WHM API (JSON)


```undefined syntaxhighlighter-pre
https://hostname.example.com:2087/cpsess###########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=MysqlFE&cpanel_jsonapi_func=getmysqlserverprivileges
```

Note:
For more information, read our [Calls from the WHM API](/whm/use-whm-api-to-call-cpanel-api-and-uapi) documentation.

### LiveAPI PHP Class


```undefined syntaxhighlighter-pre
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.

// List all MySQL permissions
$all_privileges = $cpanel->api2(
    'MysqlFE', 'getmysqlserverprivileges'
);
```

Note:
For more information, read our [Guide to the LiveAPI System](/guides/guide-to-the-liveapi-system/#guide-to-the-liveapi-system).

### LiveAPI Perl Module


```undefined syntaxhighlighter-pre
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.

# List all MySQL permissions
my $all_privileges = $cpliveapi->api2(
    'MysqlFE', 'getmysqlserverprivileges',
);
```

Note:
For more information, read our [Guide to the LiveAPI System](/guides/guide-to-the-liveapi-system).

### cPanel Tag System (deprecated)

Warnings:
- cPanel tags are **deprecated**. We **strongly** recommend that you **only** use the [LiveAPI](/guides/guide-to-the-liveapi-system) 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](/guides/guide-to-the-liveapi-system).
- 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](/cpanel-api-2/cpanel-api-2-deprecate-cpanel-tag-usage/) documentation.


### Command Line


```undefined syntaxhighlighter-pre
cpapi2 --user=username MysqlFE getmysqlserverprivileges
```

div
Notes:

- You **must** URI-encode values.
- `username` represents your account-level username.
- If you run this command as the `root`user, you **must** include the `--user=username` option.
- For more information and additional output options, read our [Guide to cPanel API 2](/cpanel-api-2/) documentation or run the `cpapi2 --help` command.
- If you run CloudLinux™, you **must** use the full path of the `cpapi2` command:

```undefined syntaxhighlighter-pre
/usr/local/cpanel/bin/cpapi2
```


br
### Output (JSON)


```undefined syntaxhighlighter-pre
{
  "cpanelresult": {
    "apiversion": 2,
    "data": [
      {
        "privilege": "ALTER",
        "description": "To alter the table"
      },
      {
        "privilege": "ALTER ROUTINE",
        "description": "To alter or drop stored functions\/procedures"
      },
      {
        "privilege": "CREATE",
        "description": "To create new databases and tables"
      },
      {
        "privilege": "CREATE ROUTINE",
        "description": "To use CREATE FUNCTION\/PROCEDURE"
      },
      {
        "privilege": "CREATE TEMPORARY TABLES",
        "description": "To use CREATE TEMPORARY TABLE"
      },
      {
        "privilege": "CREATE VIEW",
        "description": "To create new views"
      },
      {
        "privilege": "DELETE",
        "description": "To delete existing rows"
      },
      {
        "privilege": "DROP",
        "description": "To drop databases, tables, and views"
      },
      {
        "privilege": "EXECUTE",
        "description": "To execute stored routines"
      },
      {
        "privilege": "FILE",
        "description": "To read and write files on the server"
      },
      {
        "privilege": "GRANT OPTION",
        "description": "To give to other users those privileges you possess"
      },
      {
        "privilege": "INDEX",
        "description": "To create or drop indexes"
      },
      {
        "privilege": "INSERT",
        "description": "To insert data into tables"
      },
      {
        "privilege": "LOCK TABLES",
        "description": "To use LOCK TABLES (together with SELECT privilege)"
      },
      {
        "privilege": "REFERENCES",
        "description": "To have references on tables"
      },
      {
        "privilege": "SELECT",
        "description": "To retrieve rows from table"
      },
      {
        "privilege": "SHOW VIEW",
        "description": "To see views with SHOW CREATE VIEW"
      },
      {
        "privilege": "TRIGGER",
        "description": "To use triggers"
      },
      {
        "privilege": "UPDATE",
        "description": "To update existing rows"
      }
    ],
    "func": "getmysqlserverprivileges",
    "event": {
      "result": 1
    },
    "module": "MysqlFE"
  }
}
```

Note:
Use cPanel's *[API Shell](https://docs.cpanel.net/cpanel/advanced/api-shell-for-cpanel)* interface (*cPanel >> Home >> Advanced >> API Shell*) to directly test cPanel API calls.

## Parameters

This function does not accept parameters.

## Returns

table
thead
tr
th
strong
Return
th
strong
Type
th
strong
Description
th
strong
Possible values
th
strong
Example
tbody
tr
td
td
em
hash
td
A hash that contains information about each privilege.
td
A hash that contains the 
code
privileges
 and 
code
description
 returns.
td
tr
td
code
privileges
td
em
string
td
p
A privilege name.
p
The function returns this value in the privilege information hash.
td
ul
li
code
"ALTER"
li
code
"ALTER ROUTINE"
li
code
"CREATE"
li
code
"CREATE ROUTINE"
li
code
"CREATE TEMPORARY TABLES"
li
code
"CREATE VIEW"
li
code
"DELETE"
li
code
"DROP"
li
code
"EVENT"
li
code
"EXECUTE"
li
code
"INDEX"
li
code
"INSERT"
li
code
"LOCK TABLES"
li
code
"REFERENCES"
li
code
"SELECT"
li
code
"SHOW VIEW"
li
code
"TRIGGER"
li
code
"UPDATE"
td
code
ALTER
tr
td
code
description
td
em
string
td
p
A description of the privilege.
p
The function returns this value in the privilege information hash.
td
A valid string.
td
code
To alter the table
tr
td
code
reason
td
em
string
td
p
A reason for failure.
p
This function only returns a 
code
reason
 value if it failed.
td
p
A string that describes the error.
td
code
This is an error message.
tr
td
code
result
td
em
Boolean
td
p
Whether the function succeeded.
td
ul
li
code
1
 — The function succeeded.
li
code
0
 — The function failed.
td
code
1