Skip to content

Document parameters for Diagnostics/Firewall/Log #791

@korgano

Description

@korgano

Important notices

Before you add a new report, we ask you kindly to acknowledge the following:

Is your feature request related to a problem? Please describe.

I am trying to build an N8N automation workflow that obtains firewall logs for a specific interface and/or action (allow/block). However, HTTP GET request I formulate always obtains all logs within a certain period of time, with no filtering.

This heavily taxes the N8N process and makes operating on the data extremely difficult.

I lucked out while using the browser console and discovered a query that helped me partially filter the output, but I have no luck using it to further constrain the query:
https://[IP-ADDR]/api/diagnostics/firewall/log/?digest=&limit=1000

Describe the solution you like

A new article/page under How-Tos describing the known good options methods of interacting with the Diagnostics/Firewall/Log portion of the API.

Please list out all valid filters.

Known good filtering:
log/?digest=&limit=####: Controls number of displayed logs
log/?digest=&interface=[INTERFACE]: Controls what interface logs are shown.

Also, describe how to properly chain multiple filters (limit, interface, etc...)

Describe alternatives you considered

I considered making an issue on opnsense/core, but I suspect the issue is not one of missing API variables, but general lack of exposing the available parameters to the users through the documentation.

Additional context

Using browser console with Live View is currently very difficult due to the recurring bugs in 25.7.6:
opnsense/core#9310
opnsense/core#9312
opnsense/core#9324

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions