Child pages
  • UAPI Functions - Mysql::locate_server
Skip to end of metadata
Go to start of metadata

Description

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

Important:

In cPanel & WHM version 76 and later, when you disable the MySQL role, the system disables this function. For more information, read our How to Use Server Profiles documentation.

Examples


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Mysql/locate_server


Note:

This example calls the UAPI function via a cPanel session. For more information, read our Guide to UAPI documentation. 

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


Note:

For more information, read our Guide to the LiveAPI System.

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


Note:

For more information, read our Guide to the LiveAPI System.

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


Note:

For more information, read our Guide to Template Toolkit documentation. 

 Command Line
uapi --user=username Mysql locate_server


Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to UAPI documentation or run the uapi --help command. 
  • If you run CloudLinux™, you must use the full path of the uapi command:

    /usr/local/cpanel/bin/uapi


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


Note:

Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

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