Description

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


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

Examples 




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



$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',
    ) 
);

 



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',
    }
);

 




cpapi2 --user=username MysqlFE authorizehost host=remote.example.com



 {
  "cpanelresult": {
    "apiversion": 2,
    "func": "authorizehost",
    "data": [
      1
    ],
    "event": {
      "result": 1
    },
    "module": "MysqlFE"
  }
}



Parameters

ParameterTypeDescriptionPossible valuesExample
hoststring

Required

The remote hostname or IP address.

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

ReturnTypeDescriptionPossible valuesExample
reasonstring

A reason for failure.

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