UAPI Functions - Mysql::get_server_information

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


 LiveAPI PHP Class

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

 LiveAPI Perl Module

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

 cPanel Template Toolkit

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

 Command Line

uapi --user=username Mysql get_server_information

 

Notes:

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

 Output (JSON)

   "messages":null,
   "errors":null,
   "status":1,
   "metadata":{ 
 
   },
   "data":{ 
      "host":"localhost",
      "version":"5.6.23",
      "is_remote":0
   }
}

 

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 

host

string

The MySQL server's hostname.

 A MySQL hostname or IP address. 

 localhost 

version

string

The MySQL server's version.

A valid string.

5.6.23

 is_remote 

 Boolean 

 Whether the host is a remote MySQL server. 

  • 1 — Remote host.
  • 0 — Local host.

1

 

  • 4 Users Found This Useful
Was this answer helpful?

Related Articles

The cPanel Interface

For  cPanel  &  WHM  version  58 Overview The cPanel interface is...

User Preferences

For cPanel & WHM version 58 Overview This document outlines how to access your cPanel...

Manage External Authentications

For cPanel & WHM version 58 Overview Manage credentials Additional documentation...

What is cPanelID?

In This Article:  Overview ServicesHow to get a cPanelID cPanelID External...

Guide to cPanel Interface Customization - cPanel Style Development

Introduction You can develop custom styles that modify the appearance of the cPanel interface....