WHM API 1 Functions - set_local_mysql_root_password

In cPanel & WHM version 76 and later, when you disable the MySQL role, the system disables this function. For more information, read our How to Use Server Profiles documentation.

Examples

JSON API

https://hostname.example.com:2087/cpsess##########/json-api/set_local_mysql_root_password?api.version=1&password=12345luggage

XML API

https://hostname.example.com:2087/cpsess##########/xml-api/set_local_mysql_root_password?api.version=1&password=12345luggage

Command Line

whmapi1 set_local_mysql_root_password password=12345luggage

Notes:

You must URI-encode values.
For more information and additional output options, read our Guide to WHM API 1 documentation or run the whmapi1 --help command.
If you run CloudLinux™, you must use the full path of the whmapi1 command:
```
/usr/local/cpanel/bin/whmapi1
```

Output (JSON)

{
  "data": {
    "password_reset": 1
  },
  "metadata": {
    "version": 1,
    "reason": "OK",
    "result": 1,
    "command": "set_local_mysql_root_password"
  }
}

Output (XML)

<result>
    <data>
        <password_reset>1</password_reset>
    </data>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>set_local_mysql_root_password</command>
    </metadata>
</result>

Note:

Use WHM's API Shell interface (WHM >> Home >> Development >> API Shell) to directly test WHM API calls.

Parameters

Parameter Type Description Possible values Example

password

string

Required

The new MySQL root user's password.

A valid string.

12345luggage

update_config

Boolean

Whether to update the configuration files.

Warning:

This parameter updates the /root/.my.cnf file with the new password, which could cause problems with the MySQL configuration on the server. If you are unsure, do not specify this parameter.

If you set this parameter to 0 when localhost is the active profile, it will stop communication with the remote MySQL server until you update the profile's password.
If you set this parameter to 1 when a remote host is the active profile, it will stop communication with the remote MySQL server until you update the profile's password.

1 — Update.
0 — Do not update.

1

Returns

Return	Type	Description	Possible values	Example
`password_reset`	Boolean	Whether the system reset the password.	`1` — Reset. `0` — Not reset.	`1`
`configs_updated`	Boolean	Whether the system updated the configuration settings. Note: This return only appears when the function includes the `update_config` parameter or when the localhost MySQL profile is active.	`1` — Updated. `0` — Not updated.	`1`
`profile_updated`	Boolean	Whether the system updated the profile. Note: This return only appears when the localhost MySQL profile is active.	`1` — Updated. `0` — Not updated.	`1`

Function information

API Version:

WHM API 1

Available in:

WHM 11.52+

Methods:

GET, POST

Required Parameters:

password

Return Formats:

JSON, XML

Important:

cPanel & WHM version 66 deprecated XML output.

About WHM API 1

WHM API 1 performs functions and accesses data in WHM.

Notes:

Some functions and parameters may require that you authenticate as the root user.
You must use the appropriate WHM ports (2086 or 2087) to call WHM API functions.

Find a function

Related functions

Page:

WHM API 1 Functions - remote_mysql_create_profile — This function creates a profile to access a remote MySQL® server.
Page:

WHM API 1 Functions - remote_mysql_create_profile_via_ssh — This function uses SSH to create a profile to access a remote MySQL® server.
Page:

WHM API 1 Functions - remote_mysql_delete_profile — This function deletes a specified remote MySQL® profile.
Page:

WHM API 1 Functions - remote_mysql_initiate_profile_activation — This function initiates the activation process for a remote MySQL® server profile.
Page:

WHM API 1 Functions - remote_mysql_monitor_profile_activation — This function returns information about a remote MySQL® server profile activation process.

Child pages