v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB

Mysql

Remote Databases

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.

get/Mysql/get_host_notes

Response

HTTP Request was successful.

apiversioninteger

The version of the API.

funcstring

The name of the method called.

modulestring

The name of the module called.

Example response

{
  "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"
    },
    "status": 1
  }
}