Description

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

Examples




https://hostname.example.com:2083/cpsess##########/execute/Mysql/locate_server



$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Get MySQL host information.
$locate_server = $cpanel->uapi(
    'Mysql', 'locate_server'
);



my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Get MySQL host information.
my $locate_server = $cpliveapi->uapi(
    'Mysql', 'locate_server'
);



<!-- Get MySQL host information. -->
[% execute('Mysql', 'locate_server') %]



uapi --user=username Mysql locate_server



{
   "data" : {
      "is_remote" : 1,
      "remote_host" : "remote.example.com"
   },
   "errors" : null,
   "messages" : null,
   "metadata" : {},
   "status" : 1
}



Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample
remote_hoststring

The remote MySQL server's hostname.

A remote MySQL hostname or IP address.

remote.example.com
is_remoteBooleanWhether the host is a remote MySQL server.
  • 1 — Remote host.
  • 0 — Local host.
1