GET
/
ips
curl --request GET \
  --url https://app.onefirewall.com/api/v1/ips \
  --header 'Authorization: <api-key>'
{
  "header": {
    "type": "IPv4",
    "version": 2,
    "ts": "1684014988",
    "page_size": 1,
    "delay": 0,
    "eval": "return (scoreTimeZero) / (1 + Math.exp( (3/(scoreTimeZero)) * ((current_time/3600) - (2.5 * scoreTimeZero))))",
    "exec_python": "score = (scoreTimeZero) / (1 + numpy.exp( (3/(scoreTimeZero)) * ((current_time/3600) - (2.5 * scoreTimeZero))))",
    "user": {
      "guid": "OFA-GUID-XXXX-XXXX-XXXX",
      "name": "Your name",
      "surname": "Your surname",
      "username": "Your email",
      "role": 0,
      "unsuccessful_login": 0,
      "member_of": {
        "gid": "OFA-GID-XXXXXXX",
        "name": "Organisation name",
        "trust": 0.9,
        "delay": "0"
      }
    }
  },
  "body": [
    {
      "gid": "OFA-RULE-GID-XXXXXX",
      "ip": "XXX.YYY.ZZZ.WWW",
      "ts": 1684015144,
      "entry_ts": 1683928684,
      "is_network": false,
      "ip_info": {
        "as_domain": "cloudflare.com",
        "as_name": "Cloudflare, Inc.",
        "asn": "AS13335",
        "continent": "NA",
        "continent_name": "North America",
        "country": "US",
        "country_name": "United States"
      },
      "score": 34,
      "info": {
        "members": 1,
        "events": 1,
        "sources": [
          "sshlog"
        ],
        "stix_bundles": [],
        "attack_infos": [],
        "notes": [
          "May 12 23:47:55 OFA-SRV2 sshd[12317]: pam_unix(sshd:auth): authentication failure; logname= uid=0 euid=0 tty=ssh ruser= rhost=XXX.YYY.ZZZ.WWW  user=root"
        ]
      },
      "elk_ts": "2023-05-13T21:59:04.000Z",
      "elk_entry_ts": "2023-05-12T21:58:04.000Z",
      "delay": 0,
      "dec": 8.3e-7
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Authorization Token

Query Parameters

​
page_size
number
default:50

The maximum size of the array to retrieve

Required range: 0 < x < 1001
​
show_id
number
default:0

Use 0 for all feeds, 1 for feeds submitted by your organization, 2 for manually blocked/blacklisted feeds, and 3 for unblocked/whitelisted feeds.

Required range: 0 < x < 3
​
ts
integer

Timestamp from when to retreive data

Required range: x > -1
​
full
enum<string>
default:no

full=yes provide more information

Available options:
yes,
no

Response

200 - application/json

The response is of type string.