Developer Documentation
Child pages
  • WHM API 1 Functions - flush_cphulk_login_history_for_ips
Skip to end of metadata
Go to start of metadata

Guide to WHM API 1

Return Data

Filter Output

Sort Output

Paginate Output

Output Columns

Call cPanel API 2 and UAPI

 

 

Description

This function removes specific login history entries from the cPHulk database. Use this function to unblock one or more IP addresses.

Examples

 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/flush_cphulk_login_history_for_ips?api.version=1&ip=192.168.0.1
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/flush_cphulk_login_history_for_ips?api.version=1&ip=192.168.0.1
 Command Line
whmapi1 flush_cphulk_login_history_for_ips ip=192.168.0.1


Notes:

  • Unless otherwise noted, you must URI-encode values.
  • For more information and additional output options, read our Guide to WHM API 1 documentation or run the whmapi1 --help command.

  • If you run CloudLinux™, you must use the full path of the whmapi1 command:

    /usr/local/cpanel/bin/whmapi1

 Output (JSON)
{
  "data": {
    "records_removed": 1,
    "iptable_bans_removed": 1
  },
  "metadata": {
    "version": 1,
    "reason": "OK",
    "result": 1,
    "command": "flush_cphulk_login_history_for_ips"
  }
}
 Output (XML)
<result>
    <data>
        <records_removed>1</records_removed>
        <iptable_bans_removed>1</iptable_bans_removed>
    </data>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>flush_cphulk_login_history_for_ips</command>
    </metadata>
</result>


Note:

Use WHM's API Shell interface (WHM >> Home >> Development >> API Shell) to directly test WHM API calls.

Parameters

ParameterTypeDescriptionPossible valuesExample
ipstring

Required

The record's IP address.

Note:

To unblock multiple IP addresses, increment the parameter name (for example, to supply three IP addresses, use the ip-1, ip-2, and ip-3 parameters).

A valid IP address.192.168.0.1

Returns

ReturnTypeDescriptionPossible valuesExample

records_removed

integerThe number of entries that the function deleted.A valid integer.1
iptable_bans_removedintegerThe number of iptables temporary block rules that the function deleted.A valid integer.1

Function information

API Version:

WHM API 1

Available in:

WHM 11.50+

Methods:

GET, POST

Required Parameters:

ip

Return Formats:

JSON, XML

Important:

cPanel & WHM version 66 deprecated XML output.

About WHM API 1

WHM API 1 performs functions and accesses data in WHM.

Notes:

  • Some functions and parameters may require that you authenticate as the root user.
  • You must use the appropriate WHM ports (2086 or 2087) to call WHM API functions.

Find a function

Related functions