Sign in

v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB
Mysql
Remote Databases

Add remote MySQL host note

This function adds a note about a remote MySQL® server.

Important:

  • If you attempt to add a note to an unauthorized remote MySQL server, the function will fail.
  • When you disable the MySQL role, the system disables this function.
get/Mysql/add_host_note

Query parameters

string ipv4 required
OR
string domain required
OR
string required

IP address range with the percent (%) symbol as a wildcard.

OR
string required

IP address range in CIDR format.

Example:192.168.1.6

The remote MySQL server's hostname or IP address.

You may use the following IP address formats:

  • 192.168.1.6 — IP address.
  • 192.168.%.% — Range with the percent (%) symbol as a wildcard.
  • 192.168.0.0/16 — Range in CIDR format.
notestring required
Example:A remote mysql server for storing my data

note that describes the remote MySQL server.

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": "add_host_note",
  "module": "Mysql",
  "result": {
    "status": 1
  }
}