OpenSource/homepage
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update pfsense.md

Browse Source 
Fixing documentation for usage with API Token. API authorization documentation here: https://pfrest.org/AUTHENTICATION_AND_AUTHORIZATION/
This commit is contained in:
nopoz 2024-07-22 14:06:53 -07:00 committed by GitHub
parent 5d531b11e7
commit 0953052dd4
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/widgets/services/pfsense.md
View File

@ -9,7 +9,7 @@ This widget requires the installation of the [pfsense-api](https://github.com/ja
Once pfSense API is installed, you can set the API to be read-only in System > API > Settings. Once pfSense API is installed, you can set the API to be read-only in System > API > Settings.
There are two currently supported authentication modes: 'Local Database' and 'API Token'. For 'Local Database', use `username` and `password` with the credentials of an admin user. For 'API Token', utilize the `headers` parameter with `client_token` and `client_id` obtained from pfSense as shown below. Do not use both headers and username / password. There are two currently supported authentication modes: 'Local Database' and 'API Token'. For 'Local Database', use `username` and `password` with the credentials of an admin user. For 'API Token', utilize the `headers` parameter with the `X-API-Key` header name and `token` value obtained from pfSense as shown below. Do not use both headers and username / password.
The interface to monitor is defined by updating the `wan` parameter. It should be referenced as it is shown under Interfaces > Assignments in pfSense. The interface to monitor is defined by updating the `wan` parameter. It should be referenced as it is shown under Interfaces > Assignments in pfSense.
@ -24,7 +24,7 @@ widget:
username: user # optional, or API token username: user # optional, or API token
password: pass # optional, or API token password: pass # optional, or API token
headers: # optional, or username/password headers: # optional, or username/password
Authorization: client_id client_token X-API-Key: token
wan: igb0 wan: igb0
version: 2 # optional, defaults to 1 for api v1 version: 2 # optional, defaults to 1 for api v1
fields: ["load", "memory", "temp", "wanStatus"] # optional fields: ["load", "memory", "temp", "wanStatus"] # optional