cPanel API 1 Functions - Mysql::delhost - Knowledgebase

Description

This function authorizes a remote host to access a cPanel account's MySQL® users.

Warning:

cPanel API 1 is deprecated. Do not use this function. Instead, we strongly recommend that you use the following newer functions:

UAPI (recommended) — Mysql::delete_host — This function removes a remote MySQL® host's access to the account's databases.
cPanel API 2 — MysqlFE::deauthorizehost — This function removes a remote host's authorization.

Examples

LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.

$remove_remotehost = $cpanel->api1('Mysql','delhost', array('remote.example.com') ); // Call the function.

LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.

my $remove_remotehost = $cpliveapi->api1('Mysql','delhost', ['remote.example.com'] ); # Call the function.

cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. This example is present in order to help developers move from the old cPanel tag system to our LiveAPI.

We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

<cpanel Module="Mysql::delhost( $FORM('host'))">

Output (none)

This function does not return output.

Parameters

Parameter	Type	Description	Possible values	Example
host	string	Required The hostname or IP address from which to remove access.	A valid domain name or a valid IP address.	remote.example.com

Parameter

Type

Description

Possible values

Example

host

string

Required

The hostname or IP address from which to remove access.

A valid domain name or a valid IP address.

remote.example.com

Returns

This function does not return output.

Knowledgebase

Categories

Categories