v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB

Mysql

Database Information

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.

get/Mysql/locate_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": "locate_server",
  "module": "Mysql",
  "result": {
    "data": {
      "is_remote": 1,
      "remote_host": "192.0.2.1"
    },
    "status": 1
  }
}