Child pages
  • UAPI Functions - Mysql::add_host

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

 

Description

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

Panel
bgColor#F2F2F2
borderStylenone

Example


Panel
bgColor#FFFFFF
borderStylenone
Expand
titlecPanel or Webmail Session URL
Code Block
languagetext
https://hostname.example.com:2083/cpsess##########/execute/Mysql/add_host?host=remote.example.com

Include Page
LIB:_CallUAPIFromBrowserLink
LIB:_CallUAPIFromBrowserLink

Expand
titleLiveAPI PHP Class
Code Block
languagephp
linenumberstrue
$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',
    )
);

Include Page
LIB:_LiveAPIPHPLink
LIB:_LiveAPIPHPLink

Expand
titleLiveAPI Perl Module
Code Block
languageperl
linenumberstrue
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',
    }
);

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink

Expand
titlecPanel Template Toolkit
Code Block
languagexml
linenumberstrue
<!-- Authorize a remote host. -->
[% execute('Mysql', 'add_host', { host => 'remote.example.com' } ) %]

Include Page
LIB:_TTLink
LIB:_TTLink

Expand
titleCommand Line
Code Block
languagetext
uapi --user=username Mysql add_host host=remote.example.com

Include Page
LIB:_UAPICLINote
LIB:_UAPICLINote

Expand
titleOutput (JSON)
Code Block
languagetext
linenumberstrue
{
  "messages": null,
  "errors": null,
  "status": 1,
  "metadata": {
     
  },
  "data": null
}

Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote

Parameters

ParameterTypeDescriptionPossible valuesExample
hoststring

Required

The remote MySQL server's hostname.

A remote MySQL hostname or IP address.

Note
titleNote:

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.