View Source

Description

This function deletes an IP address from the Greylisting Trusted Hosts list.

Examples

https://hostname.example.com:2087/cpsess##########/json-api/delete_cpgreylist_trusted_host?api.version=1&ip=10.10.10.1&ip-1=5.5

https://hostname.example.com:2087/cpsess##########/xml-api/delete_cpgreylist_trusted_host?api.version=1&ip=10.10.10.1&ip-1=5.5

whmapi1 delete_cpgreylist_trusted_host ip=10.10.10.1 ip-1=5.5

{
  "data": {
    "ips_removed": [
      "10.10.10.1"
    ],
    "ips_failed": {
      "5.5": "Invalid IP address or range: \u201c5.5\u201d"
    }
  },
  "metadata": {
    "version": 1,
    "reason": "OK",
    "result": 1,
    "command": "delete_cpgreylist_trusted_host"
  }
}

<result>
    <data>
        <ips_removed>10.10.10.1</ips_removed>
        <ips_failed>5.5</ips_failed>
            <ip-1>"Invalid IP address or range: \u201c5.5\u201d"</ip-1> 
    </data>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>delete_cpgreylist_trusted_host</command>
    </metadata>
</result>

Parameters

Parameter Type Description Possible values Example

ip

string

Required

The record's IP address, or a range of IP addresses.

To add multiple IP addresses, increment the parameter name (for example, ip-1, ip-2, ip-3).

A valid IP address or range of IP addresses.

192.168.0.1

Returns

Return	Type	Description	Possible values	Example
`ips_failed`	hash	A hash of the IP addresses that the function failed to add to the Trusted Hosts list.	This hash includes the `host_ip` and `comment` returns.
`host_ip`	string	The failed IP address. The function returns this value in the `ips_failed` hash.	A valid string.	`5.5`
`comment`	sting	A description of why the function failed to delete the record. The function returns this value in the `ips_failed` hash.	A valid string.	Invalid IP address or range: \u201c5.5\u201d
`ips_removed`	array of hashes	An array of hashes of the IP addresses that the function removed from the Trusted Hosts list.	Each hash includes the `host_ip` return.
`host_ip`	string	The removed host's IP address. The function returns this value in the `ips_removed` array.	A valid IP address.	`192.168.0.1`

Function information

API Version:

WHM API 1

Available in:

WHM 11.50+

Methods:

GET, POST

Required Parameters:

ip

Return Formats:

JSON, XML

Description

Examples

Parameters

Returns

Function information

About WHM API 1

Find a function

Related functions