Child pages
  • WHM API 1 Functions - rename_mysql_user

Versions Compared

Key

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

Description

Excerpt

This function changes a MySQL® database user's name.

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
titleJSON API


Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/json-api/rename_mysql_user?api.version=1&oldname=username&newname=username2&cpuser=example



Expand
titleXML API


Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/xml-api/rename_mysql_user?api.version=1&oldname=username&newname=username2&cpuser=example



Expand
titleCommand Line


Code Block
languagebash
whmapi1 rename_mysql_user oldname=username newname=username2 cpuser=example

Include Page
LIB:_WHMAPI1CLINote
LIB:_WHMAPI1CLINote


Expand
titleOutput (JSON)


Code Block
languagetext
linenumberstrue
{
  "metadata": {
    "version": 1,
    "reason": "OK",
    "result": "1",
    "command": "rename_mysql_user"
  }
}



Expand
titleOutput (XML)


Code Block
languagetext
linenumberstrue
<result>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>rename_mysql_user</command>
    </metadata>
</result>


Include Page
LIB:_WHMAPIShellNote
LIB:_WHMAPIShellNote


Parameters

ParameterTypeDescriptionPossible valuesExample
oldnamestring

Required

The database user's current name.

A valid username.

Include Page
LIB:_MySQL Username Limit
LIB:_MySQL Username Limit

 username

newname

string

Required

The database user's new name.

A valid username.

Warning
titleWarning

If database prefix is enabled, this parameter must include the database prefix for the account.


username2
cpuserstringThe database user's owner.A valid username.example

Returns

This function only returns metadata.

Note
titleNote:

This function's metadata includes the payload_is_literal return. For more information, read our WHM API 1 - Return Data documentation.