Description

This function authorizes a remote MySQL® host to access the account's databases.

Example


https://hostname.example.com:2083/cpsess##########/execute/Mysql/add_host?host=remote.example.com

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Authorize a remote host.
$add_host = $cpanel->uapi(
    'Mysql', 'add_host',
    array(
        'host'       => 'remote.example.com',
    )
);

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Authorize a remote host.
my $add_host = $cpliveapi->uapi(
    'Mysql', 'add_host',
    {
        'host'       => 'remote.example.com',
    }
);

<!-- Authorize a remote host. -->
[% execute('Mysql', 'add_host', { host => 'remote.example.com' } ) %]

uapi --user=username Mysql add_host host=remote.example.com

{
  "messages": null,
  "errors": null,
  "status": 1,
  "metadata": {
     
  },
  "data": null
}

Parameters

ParameterTypeDescriptionPossible valuesExample
hoststring

Required

The remote MySQL server's hostname.

A remote MySQL hostname or IP address.

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.