cPanel API 2 Functions - MysqlFE::getmysqlserverprivileges - Knowledgebase

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.

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

LiveAPI PHP Class

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

// List all MySQL permissions

$all_privileges = $cpanel->api2(

'MysqlFE', 'getmysqlserverprivileges'

);

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

);

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 getmysqlserverprivileges

Notes:

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

 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 (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 descriptionreturns.
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. Note: 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

Knowledgebase

Categories

Categories