latestOpenAPI 3.0.2cPanel License2026-08-106251554.3 MB

3da41671c02c

Databases
Remote MySQL Databases

Update remote MySQL profile

This function updates one or more parameters for a remote MySQL® profile.

Note: This function requires the name parameter and one of more of the mysql_host , mysql_user, mysql_pass, mysql_port, or setup_via parameters.

get/remote_mysql_update_profile

Query parameters

namestring required
Example:MyProfile

The profile's name.

string ipv4
OR
string hostname

The MySQL server's IP address or hostname.

mysql_passstring
Example:12345luggage

The MySQL server's password.

mysql_portinteger
Example:3306

The MySQL server's port.

mysql_userstring
Example:username

The MySQL server's username.

setup_viastring
Example:Main terminal

A description of the profile data.

Response

HTTP Request was successful.

Example response

{
  "data": {
    "profile_details": {
      "mysql_pass": "12345luggage",
      "mysql_port": 3306,
      "mysql_user": "username",
      "setup_via": "Main terminal"
    },
    "profile_saved": "MyProfile"
  },
  "metadata": {
    "command": "remote_mysql_update_profile",
    "reason": "OK",
    "result": 1,
    "version": 1
  }
}