Sign in

v1

latestOpenAPI 3.0.02026-07-14198572488.4 KB
Reporting

List WAF Events

Lists all requests which triggered actions in the Web Application Firewall (WAF)

get/v1/reporting/sites/{id}/waf/eventlist

Path parameters

idinteger required

ID of the Site you are interacting with

Example:8880000888

Query parameters

duration'30m' | '1h' | '6h' | '12h' | '24h' | '72h' | '7d' | '30d' required

Duration that the listed data is for (m = minutes, h = hours, d = days)

Example:7d
searchstring

Search for an event by action, client_ip, country, request_path, user_agent, or query_string

Example:/admin-ajax.php
actionstring[]

Filter events matching a specific action taken by the WAF

[
  "allow"
]
client_ipstring
Example:1.2.3.4

Filter events matching a specific IP address

request_pathstring
Example:/wp-login.php

Filter events matching a specific request path or partial path

countrystring[]

Filter events matching a specific country

[
  "US"
]
asnstring
Example:14618

Filter events matching a specific ASN

asn_descriptionstring
Example:AMAZON-AES

Filter events matching a specific or partial ASN description

http_methodstring[]

Filter events matching a specific HTTP method

[
  "POST"
]
http_protocolstring
Example:HTTP/1.1

Filter events matching a specific or partial HTTP Protocol

query_stringstring
Example:&bad=request

Filter events matching a specific or partial Query String

ray_idstring
Example:1234567890

Filter events matching a specific or partial Ray ID

user_agentstring
Example:Mozilla/5.0

Filter events matching a specific or partial HTTP User Agent

per_pageinteger

How many results to include in each page (default = 10)

pageinteger

Page of results to include (default = 1)

Response

OK

successboolean

whether the request succeeded

errorsstring[]
messagesstring[] nullable

Example response

{
  "success": true,
  "errors": [],
  "messages": [],
  "metadata": {
    "page": 1,
    "page_size": 10,
    "total": 150
  },
  "result": [
    {
      "action": "block",
      "clientASNDescription": "UUNET",
      "clientAsn": "701",
      "clientCountryName": "US",
      "clientIP": "1.2.3.4",
      "clientRequestHTTPHost": "rocket.net",
      "clientRequestHTTPMethodName": "GET",
      "clientRequestHTTPProtocol": "HTTP/2",
      "clientRequestPath": "/blog/the-rocket-difference-how-we-created-the-fastest-wordpress-hosting-in-the-world/",
      "clientRequestQuery": "?rocket=fast",
      "datetime": "2024-08-19T20:05:00Z",
      "metadata": [
        {
          "key": "ruleset_version",
          "value": "10"
        }
      ],
      "rayName": "8b5cc1855d86842a",
      "ruleId": "bfd30cf7be1e4f0b871c7d10dda5fc66",
      "sampleInterval": 3.8457300275482096,
      "source": "firewallCustom",
      "userAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 17_6_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Mobile/15E148 [FBAN/FBIOS;FBAV/471.0.0.27.107;FBBV/632147304;FBDV/iPhone15,3;FBMD/iPhone;FBSN/iOS;FBSV/17.6.1;FBSS/3;FBCR/;FBID/phone;FBLC/en_US;FBOP/80]"
    }
  ]
}