cPanel API 2 Functions - MysqlFE::getmysqlserverprivileges

Warning:

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

Description

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

Warning:

We strongly recommend that you use UAPI instead of cPanel API 2. However, no equivalent UAPI function exists.

Important:

When you disable the MySQL/MariaDB role and remote MySQL is not already configured, the system disables this function.

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=getmysqlserverprivileges

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.

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

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.

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

Note:

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

cPanel Tag System (deprecated)

Warnings:

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 getmysqlserverprivileges

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 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": [
      {
        "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 interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

This function does not accept parameters.

Returns

Return	Type	Description	Possible values	Example
	hash	A hash that contains information about each privilege.	A hash that contains the `privileges` and `description` returns.
`privileges`	string	A privilege name. The function returns this value in the privilege information hash.	`"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"`	`ALTER`
`description`	string	A description of the privilege. The function returns this value in the privilege information hash.	A valid string.	`To alter the table`
`reason`	string	A reason for failure. This function only returns a `reason` value 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`