Validate remote MySQL profile connection

This function validates a specified remote MySQL® profile's connection details.

SecurityBasicAuth
Request
query Parameters
name
required
string

The profile's name.

Example: name=MyProfile
Responses
200

HTTP Request was successful.

Response Schema: application/json
object
object
get/remote_mysql_validate_profile
Request samples
whmapi1 --output=jsonpretty \
  remote_mysql_validate_profile \
  name='MyProfile'
Response samples
application/json
{
  • "data": {
    • "profile_validated": "MyProfile"
    },
  • "metadata": {
    • "command": "remote_mysql_validate_profile",
    • "reason": "OK",
    • "result": 1,
    • "version": 1
    }
}