Description
This function authorizes a remote MySQL® host to access the account's databases.
Example
cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Mysql/add_host?host=remote.example.com
LiveAPI PHP Class
$cpanel = new CPANEL();
$add_host = $cpanel->uapi(
'Mysql', 'add_host',
array(
'host' => 'remote.example.com',
)
);
LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new();
my $add_host = $cpliveapi->uapi(
'Mysql', 'add_host',
{
'host' => 'remote.example.com',
}
);
cPanel Template Toolkit
[% execute('Mysql', 'add_host', { host => 'remote.example.com' } ) %]
Command Line
uapi --user=username Mysql add_host host=remote.example.com
|
Output (JSON)
{
"messages": null,
"errors": null,
"status": 1,
"metadata": {
},
"data": null
}
Parameters
|
Parameter
|
Type
|
Description
|
Possible values
|
Example
|
|
host
|
string
|
Required
The remote MySQL server's hostname.
|
A remote MySQL hostname or IP address.
Note:
You may use the following IP address formats:
- 192.168.1.6 — IP address.
- 192.168.%.% — Range with the percent (%) symbol as a wildcard.
- 192.168.0.0/16 — Range in CIDR format.
|
remote.example.com
|
Returns
This function only returns metadata.
