Child pages
  • WHM API 1 Functions - flush_cphulk_login_history_for_ips

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description

Excerpt

This function removes specific login history entries from the cPHulk database.

 Use this function to unblock one or more IP addresses.

Panel
bgColor#F2F2F2
borderStylenone

Examples


Panel
bgColor#FFFFFF
borderStylenone
Expand
titleJSON API
Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/json-api/flush_cphulk_login_history_for_ips?api.version=1&ip=192.168.0.1
Expand
titleXML API
Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/xml-api/flush_cphulk_login_history_for_ips?api.version=1&ip=192.168.0.1
Expand
titleCommand Line
Code Block
languagebash
whmapi1 flush_cphulk_login_history_for_ips ip=192.168.0.1

Include Page
LIB:_WHMAPI1CLINote
LIB:_WHMAPI1CLINote

Expand
titleOutput (JSON)
Code Block
languagetext
linenumberstrue
{
  "data": {
    "records_removed": 1,
    "iptable_bans_removed": 1
  },
  "metadata": {
    "version": 1,
    "reason": "OK",
    "result": 1,
    "command": "flush_cphulk_login_history_for_ips"
  }
}
Expand
titleOutput (XML)
Code Block
languagetext
linenumberstrue
<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>

Include Page
LIB:_WHMAPIShellNote
LIB:_WHMAPIShellNote

Parameters

ParameterTypeDescriptionPossible valuesExample
ipstring

Required

The record's IP address.

Note
titleNote:

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