Return remote MySQL host notes

This function returns the notes associated with the account's remote MySQL® hosts.

Important:

When you disable the MySQL/MariaDB role and remote MySQL is not already configured, the system disables this function.

SecurityBasicAuth
Responses
200

HTTP Request was successful.

Response Schema: application/json
apiversion
integer

The version of the API.

func
string

The name of the method called.

module
string

The name of the module called.

object
get/Mysql/get_host_notes
Request samples
uapi --output=jsonpretty \
  --user=username \
  Mysql \
  get_host_notes
Response samples
application/json
{
  • "apiversion": 3,
  • "func": "get_host_notes",
  • "module": "Mysql",
  • "result": {
    • "data": {
      • "1.2.3.45": "The combination on my luggage",
      • "12.34.56.78": "Located somewhere in the Ford Galaxy",
      • "8.8.8.8": "Located on Spaceball 1"
      },
    • "errors": null,
    • "messages": null,
    • "metadata": { },
    • "status": 1,
    • "warnings": null
    }
}