UAPI Functions - Mysql::locate_server - Knowledgebase

Description

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

Examples

cPanel or Webmail Session URL

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

LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.

// Get MySQL host information.

$locate_server = $cpanel->uapi(

'Mysql', 'locate_server'

);

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'

);

cPanel Template Toolkit

[% execute('Mysql', 'locate_server') %]

Command Line

uapi --user=username Mysql locate_server

Notes:

You must URI-encode values.
username represents your account-level username.

 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 (Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

This function does not accept parameters.

Returns

Return	Type	Description	Possible values	Example
remote_host	string	The remote MySQL server's hostname.	A remote MySQL hostname or IP address.	remote.example.com
is_remote	Boolean	Whether the host is a remote MySQL server.	1 — Remote host. 0 — Local host.	1

Knowledgebase

Categories

Categories