cPanel API 2 Functions - MysqlFE::authorizehost - Knowledgebase

Description

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

Warning:

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

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

Examples

WHM API (JSON)

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

 LiveAPI PHP Class

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

 LiveAPI Perl Module

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

cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

cPanel API 2 calls that use cPanel tags vary widely in code syntax and in their output. For more information, read our Deprecated cPanel Tag Usage documentation. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.

 Output (JSON)

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

Note:

Use cPanel's API Shell interface (Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

Parameter	Type	Description	Possible values	Example
host	string	Required The remote hostname or IP address.	A valid 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

Parameter

Type

Description

Possible values

Example

host

string

Required

The remote hostname or IP address.

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

Return	Type	Description	Possible values	Example
reason	string	A reason for failure. Note: This function only returns a reasonvalue if it failed.	A string that describes the error.	This is an error message.
result	boolean	Whether the function succeeded.	1 — The function succeeded. 0 — The function failed.	1

Return

Type

Description

Possible values

Example

reason

string

A reason for failure.

Note:

This function only returns a reasonvalue if it failed.

A string that describes the error.

This is an error message.

result

boolean

Whether the function succeeded.

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

Knowledgebase

Categories

Categories