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.
Authorizations:
query Parameters
required
string or string or string or string

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.
Example: host=192.168.1.6
note
required
string

note that describes the remote MySQL server.

Example: note=A remote mysql server for storing my data

Responses

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

Request samples

uapi --user=username Mysql add_host_note host='192.168.1.6' note='A remote mysql server for storing my data'

Response samples

Content type
application/json
{
  • "apiversion": 3,
  • "func": "add_host_note",
  • "module": "Mysql",
  • "result": {
    • "data": null,
    • "errors": null,
    • "messages": null,
    • "metadata": { },
    • "status": 1,
    • "warnings": null
    }
}