Child pages
  • cPanel API 2 Functions - MysqlFE::authorizehost

Versions Compared

Key

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

 

Description

Excerpt
This function authorizes a host for remote access to the account's database.

Warning
titleWarning:

We strongly recommend that you use the following Guide to UAPI function instead of this function:

  • Mysql::add_host
    Excerpt Include
    UAPI Functions - Mysql::add_host
    UAPI Functions - Mysql::add_host
    nopaneltrue
Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone
Expand
titleWHM API (JSON)
Code Block
languagetext
https://hostname.example.com:2087/cpsess###########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=MysqlFE&cpanel_jsonapi_func=authorizehost&host=remote.example.com

Include Page
LIB:_CallFromWHMAPILink
LIB:_CallFromWHMAPILink

Expand
titleLiveAPI PHP Class
Code Block
languagephp
linenumberstrue
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Authorizes the "remote.example.com" remote host
$authorize_host = $cpanel->api2(
    'MysqlFE', 'authorizehost', 
    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.
 
# Authorizes the "remote.example.com" remote host
my $authorize_host = $cpliveapi->api2(
    'MysqlFE', 'authorizehost',
    { 
        'host' => 'remote.example.com',
    }
);

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink

 

Expand
titlecPanel Tag System (deprecated)

Include Page
LIB:_cPanelAPI2cPanelTagsWarning
LIB:_cPanelAPI2cPanelTagsWarning

Expand
titleCommand Line
Code Block
languagebash
cpapi2 --user=username MysqlFE authorizehost host=remote.example.com

Include Page
LIB:_cPanelAPI2CLINote
LIB:_cPanelAPI2CLINote

Expand
titleOutput (JSON)
Code Block
languagetext
linenumberstrue
 {
  "cpanelresult": {
    "apiversion": 2,
    "func": "authorizehost",
    "data": [
      1
    ],
    "event": {
      "result": 1
    },
    "module": "MysqlFE"
  }
}

Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote

   

Parameters

ParameterTypeDescriptionPossible valuesExample
hoststring

Required

The remote hostname or IP address.

A valid 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

ReturnTypeDescriptionPossible valuesExample
reasonstring

A reason for failure.

Note
titleNote:

This function only returns a reason value if it failed.

A string that describes the error.

This is an error message.
resultBoolean

Whether the function succeeded.

  • 1 — The function succeeded.
  • 0 — The function failed.
1