Description

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

Examples 




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



$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// List all MySQL permissions
$all_privileges = $cpanel->api2(
    'MysqlFE', 'getmysqlserverprivileges'
);

 



my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# List all MySQL permissions
my $all_privileges = $cpliveapi->api2(
    'MysqlFE', 'getmysqlserverprivileges',
);

 




cpapi2 --user=username MysqlFE getmysqlserverprivileges



{
  "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"
  }
}



Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample
 hashA 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
reasonstring

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.
resultBoolean

Whether the function succeeded.

  • 1 — The function succeeded.
  • 0 — The function failed.
1