Return remote MySQL profile

This function displays the details of a specified remote MySQL® profile.

SecurityBasicAuth
Request
query Parameters
name
required
string

The MySQL profile's name.

Example: name=MyProfile
Responses
200

HTTP Request was successful.

Response Schema: application/json
object
object
get/remote_mysql_read_profile
Request samples
whmapi1 --output=jsonpretty \
  remote_mysql_read_profile \
  name='MyProfile'
Response samples
application/json
{
  • "data": {
    • "profile_details": {
      • "active": 0,
      • "mysql_host": "192.168.0.1",
      • "mysql_pass": "123456luggage",
      • "mysql_port": 3306,
      • "mysql_user": "username",
      • "setup_via": "Main terminal"
      },
    • "profile_name": "MyProfile"
    },
  • "metadata": {
    • "command": "remote_mysql_read_profile",
    • "reason": "OK",
    • "result": 1,
    • "version": 1
    }
}