List Live Firewall Logs

GET

/network/firewall/logs/live

curl --request GET \
  --url 'https://sylve.lan:8181/api/network/firewall/logs/live?cursor=0&limit=200&ruleType=traffic&action=pass&direction=in' \
  --header 'Authorization: <Authorization>'

List live firewall rule hits after a cursor. Cursor 0 starts at the current stream position without replaying retained history.

Authorizations

• BearerAuth

Parameters

Query Parameters

cursor

integer

0

Return hits after this cursor; 0 initializes the live stream

limit

integer

default: 200 >= 1 <= 2000

Maximum hits to return; values above 2000 are capped

ruleType

string

Allowed values: traffic nat

Rule type

ruleId

integer

>= 1

Rule ID

action

string

Allowed values: pass block scrub nat binat rdr

PF action

direction

string

Allowed values: in out

Packet direction

interface

string

PF interface name

query

string

Text search over the rule name, ID, and rendered log line

Responses

200

Success

Media typeapplication/json

object

data

object

items

Array<object>

object

action

string

bytes

integer

cursor

integer

direction

string

interface

string

rawLine

string

ruleId

integer

ruleName

string

ruleType

Traffic|nat

string

timestamp

string

nextCursor

integer

sourceError

string

sourceStatus

Ok|unavailable

string

updatedAt

string

error

string

message

string

status

string

Example^generated

{
  "data": {
    "items": [
      {
        "action": "example",
        "bytes": 1,
        "cursor": 1,
        "direction": "example",
        "interface": "example",
        "rawLine": "example",
        "ruleId": 1,
        "ruleName": "example",
        "ruleType": "example",
        "timestamp": "example"
      }
    ],
    "nextCursor": 1,
    "sourceError": "example",
    "sourceStatus": "example",
    "updatedAt": "example"
  },
  "error": "example",
  "message": "example",
  "status": "example"
}

400

Bad Request

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

401

Unauthorized

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

403

Forbidden

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

500

Internal Server Error

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}