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

added pfsense api key auth docs & example

Browse Source
This commit is contained in:
zmweske 2024-03-19 21:02:29 -05:00
parent 017bf487a6
commit df8dda6498
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

@ -11,7 +11,7 @@ Once pfSense API is installed, you can set the API to be read-only in System > A
There are two currently supported authentication modes: 'Local Database' and 'API Token'. To for 'Local Database', use the `username` and `password` fields with the credentials of a pfSense admin user. For 'API Token', utilize the `headers` parameter as shown below. When generating a new key, the client_token will be shown once at the top of the page in an alert box and the client_id will be at the bottom of the page. Do not use both `headers` and `username`/`password`. There are two currently supported authentication modes: 'Local Database' and 'API Token'. To for 'Local Database', use the `username` and `password` fields with the credentials of a pfSense admin user. For 'API Token', utilize the `headers` parameter as shown below. When generating a new key, the client_token will be shown once at the top of the page in an alert box and the client_id will be at the bottom of the page. Do not use both `headers` and `username`/`password`.
WAN interface to monitor can be defined by updating the `wan` param. The interface to monitor is defined by updating the `wan` param. It should be referenced as it is shown under Interfaces > Assignments in the 'Network port' column next to the MAC address.
Load is returned instead of cpu utilization. This is a limitation in the pfSense API due to the complexity of this calculation. This may become available in future versions. Load is returned instead of cpu utilization. This is a limitation in the pfSense API due to the complexity of this calculation. This may become available in future versions.
@ -23,7 +23,7 @@ widget:
url: http://pfsense.host.or.ip:port url: http://pfsense.host.or.ip:port
username: user # optional- use if avoiding api keys (headers) username: user # optional- use if avoiding api keys (headers)
password: pass # optional- use if avoiding api keys (headers) password: pass # optional- use if avoiding api keys (headers)
headers: # use this instead of username and password with API keys headers: # for use with API keys instead of username/password
Authorization: client_id client_token Authorization: client_id client_token
wan: igb0 wan: igb0
``` ```