Description

This function lists brute force attack entries from the cPHulk database.

Examples 


https://hostname.example.com:2087/cpsess##########/json-api/json-api/get_cphulk_brutes?api.version=1
https://hostname.example.com:2087/cpsess##########/xml-api/json-api/get_cphulk_brutes?api.version=1
whmapi1 get_cphulk_brutes

{
 "data": {
    "brutes": [
      {
        "exptime": "2014-11-07 00:00:00",
        "timeleft": "14",
        "notes": "this was a triumph",
        "logintime": "2014-10-20 00:00:00",
        "ip": "192.168.0.1"
      },
      {
        "exptime": "2014-11-20 00:00:00",
        "timeleft": "8",
        "notes": "I'm making a note here:",
        "logintime": "2014-10-20 00:00:00",
        "ip": "192.168.0.2"
      },
    ]
  },
  "metadata": {
    "version": 1,
    "reason": "OK",
    "result": 1,
    "command": "get_cphulk_brutes"
  }
}
<result>
    <data>
        <brutes>
            <exptime>2014-11-07 00:00:00</exptime>
            <timeleft>14</timeleft>
            <notes>this was a triumph</notes>
            <logintime>2014-10-20 00:00:00</logintime>
            <ip>192.168.0.2</ip>
        </brutes>
        <brutes>
            <exptime>2014-11-20 00:00:00</exptime>
            <timeleft>8</timeleft>
            <notes>I'm making a note here:</notes>
            <logintime>2014-10-20 00:00:00</logintime>
            <ip>192.168.0.2</ip>
        </brutes>
    </data>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>get_cphulk_brutes</command>
    </metadata>
</result>

Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample
brutesarray of hashesAn array of information about each brute force attack.This array includes the exptime, timeleft, notes, logintime, and ip returns. 

exptime

string

When the login request will time out.

The function returns this value in the brutes array.

A valid time in YYYY-MM-DD hh:mm:ss format, where:

  • YYYY represents the year.
  • MM represents the month.
  • DD represents the day.
  • hh represents the hour.
  • mm represents the minute.
  • ss represents the second.
2014-12-07 00:00:00

timeleft

integer

The number of minutes that remain before cPHulk removes the block.

The function returns this value in the brutes array.

A positive integer that represents a number of minutes.14

notes

string

The login entry's notes.

The function returns this value in the brutes array.

A valid string.this was a triumph

logintime

string

When the login attempt occurred.

The function returns this value in the brutes array.

A valid time in YYYY-MM-DD hh:mm:ss format, where:

  • YYYY represents the year.
  • MM represents the month.
  • DD represents the day.
  • hh represents the hour.
  • mm represents the minute.
  • ss represents the second.
2014-11-20 00:00:00

ip

string

The IP address of the login attempt.

The function returns this value in the brutes array.

A valid IP address.192.168.0.1