Child pages
  • cPanel API 2 Functions - MysqlFE::getmysqlprivileges

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description

Excerpt

This function lists the account's MySQL® privileges.

Include Page
LIB:_cPanelAPI2NoEquivalent
LIB:_cPanelAPI2NoEquivalent

Multiexcerpt include
SpaceWithExcerptcom.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@12665
MultiExcerptNameAPIDisabledMySQLRole
PageWithExcerptLIB:_ServerRoleDisabledAPI

Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone


Expand
titleWHM API (JSON)


Code Block
languagetext
https://hostname.example.com:2087/cpsess###########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=MysqlFE&cpanel_jsonapi_func=getmysqlprivileges

Include Page
LIB:_CallFromWHMAPILink
LIB:_CallFromWHMAPILink


Expand
titleLiveAPI PHP Class


Code Block
languagephp
linenumberstrue
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// List account MySQL permissions
$my_privileges = $cpanel->api2(
    'MysqlFE', 'getmysqlprivileges'
);

Include Page
LIB:_LiveAPIPHPLink
LIB:_LiveAPIPHPLink

 


Expand
titleLiveAPI Perl Module


Code Block
languageperl
linenumberstrue
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# List account MySQL permissions
my $my_privileges = $cpliveapi->api2(
    'MysqlFE', 'getmysqlprivileges',
);

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink

 


Expand
titlecPanel Tag System (deprecated)

Include Page
LIB:_cPanelAPI2cPanelTagsWarning
LIB:_cPanelAPI2cPanelTagsWarning


Expand
titleCommand Line


Code Block
languagebash
cpapi2 --user=username MysqlFE getmysqlprivileges

Include Page
LIB:_cPanelAPI2CLINote
LIB:_cPanelAPI2CLINote


Expand
titleOutput (JSON)


Code Block
languagetext
linenumberstrue
{
  "cpanelresult": {
    "apiversion": 2,
    "data": [
      "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"
    ],
    "func": "getmysqlprivileges",
    "event": {
      "result": 1
    },
    "module": "MysqlFE"
  }
}


Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote


Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample
 array

A list of 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"


Expand
titleClick to view...
"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"


reasonstring

A reason for failure.

Note
titleNote:

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