Return MySQL server host information

This function returns information about the account's MySQL® host.

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/locate_server

Request samples

CLI
URL
LiveAPI Perl
LiveAPI PHP

uapi --output=jsonpretty \
  --user=username \
  Mysql \
  locate_server

Response samples

application/json

{"apiversion": 3,
"func": "locate_server",
"module": "Mysql",
"result": {"data": {"is_remote": 1,
"remote_host": "192.0.2.1"
},
"errors": null,
"messages": null,
"metadata": { },
"status": 1,
"warnings": null
}
}