UAPI Functions - Mysql::set_password - Knowledgebase

Description

This function sets a MySQL® database user's password.

Examples

cPanel or Webmail Session URL

https://hostname.example.com:2083/cpsess##########/execute/Mysql/set_password?user=dbuser&password=12345luggage

 LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// Update dbuser's password.
$update_dbuser_password = $cpanel->uapi(
    'Mysql', 'set_password',
    array(
        'user'           => 'dbuser',
        'password'       => '12345luggage',
    )
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Update dbuser's password.
my $update_dbuser_password = $cpliveapi->uapi(
    'Mysql', 'set_password',
    {
        'user'           => 'dbuser',
        'password'       => '12345luggage',
    }
);

cPanel Template Toolkit

[% execute('Mysql', 'set_password', { user => 'dbuser', password => '12345luggage' } ) %]

Command Line

uapi --user=username Mysql set_password user=dbuser password=12345luggage

Notes:

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

 Output (JSON)

{
  "messages": null,
  "errors": null,
  "status": 1,
  "metadata": {
     
  },
  "data": {
    "failures": [
      {
        "host": "hostname.example.com",
        "error": "These are not the droids that you are looking for."
      }
    ]
  }
}

Note:

Use cPanel's API Shell interface (Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

Parameter	Type	Description	Possible values	Example
user	string	Required The MySQL database user.	A MySQL database user on the cPanel account.	dbuser
password	string	Required The user's new password.	A secure password that meets the server's minimum MySQL password strength requirements.	12345luggage

Parameter

Type

Description

Possible values

Example

user

string

Required

The MySQL database user.

A MySQL database user on the cPanel account.

dbuser

password

string

Required

The user's new password.

A secure password that meets the server's minimum MySQL password strength requirements.

12345luggage

Returns

Return	Type	Description	Possible values
failures	array of hashes	An array of the function's error messages. Note: cPanel & WHM introduced this array in version 11.48.	This array includes the host and errorvalue.
host	string	The hostname that reported the error. The function returns this value in the failures array.	A valid hostname.
error	string	The error message. The function returns this value in the failures array.	A valid string.

Knowledgebase

Categories

Categories