OPNsense
Firewall
OPNsense is an open-source, easy-to-use, and easy-to-build firewall and routing platform
Widgets & Capabilities​
Firewall MonitoringDisplays a summary of firewalls.
Adding the integration​
You can find how to add the integration on the Integrations Management documentation page.
Secrets​
- ApiKey (Key & Secret)
info
This integration does not require full API access to the firewall. The following guide outlines the process for creating a restricted OPNsense user with a scrambled password, designed exclusively for API access. This ensures minimal permissions and prevents local login capability.
| Name | Description |
|---|---|
Api Key (Key) | The Key part of the API Key for authentication. |
Api Key (Secret) | The Secret part of the API Key for authentication. |
Steps to retrieve the credentials:
- Log in to the OPNsense web interface as an administrator
- Navigate to System → Access → Users
- Click the + (Add) button to create a new user
- Fill in the user details:
- Username: Enter a unique name
- Password: Leave empty
- Scrambled Password: Enable this option
- Full name: (Optional) Add a descriptive name
- In Privileges section → Select the option below:
- Lobby: Dashboard
- Reporting: Traffic
- Click Save
- Return to the Users list
- Find the user and click the ticket icon in the Commands column
- Click Yes in the popup to confirm
- A txt file will download automatically, containing: Key and Secret
- Save this file securely—this information will only be shown once