Page tree
Skip to end of metadata
Go to start of metadata

 

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

Note:

This example calls the UAPI function via a cPanel session. For more information, read our Guide to UAPI documentation. 

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

Note:

For more information, read our Guide to the LiveAPI System.

 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',
    }
);

Note:

For more information, read our Guide to the LiveAPI System.

 cPanel Template Toolkit
<!-- Update the password. -->
[% execute('Mysql', 'set_password', { user => 'dbuser', password => '12345luggage' } ) %]

Note:

For more information, read our Guide to Template Toolkit documentation. 

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

Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to UAPI documentation or run the uapi --help command. 
  • We introduced this functionality in cPanel & WHM version 56.

 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 (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

ParameterTypeDescriptionPossible valuesExample
userstring

Required

The MySQL database user.

A MySQL database user on the cPanel account.

dbuser
passwordstring

Required

The user's new password.

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

12345luggage

Returns

ReturnTypeDescriptionPossible values
failuresarray 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 error value.

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.