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

Correct api key docs for pfsense v1 vs v2

Browse Source
This commit is contained in:
shamoon 2024-07-23 18:56:32 -07:00
parent 3f0fede654
commit 347cc30415
1 changed files with 11 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
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 Key'. For 'Local Database', use `username` and `password` with the credentials of an admin user. For 'API Key', utilize the `headers` parameter with the `X-API-Key` header name and `key` value 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 Key' (v2) / 'API Token' (v1). For 'Local Database', use `username` and `password` with the credentials of an admin user. The specifics of using the API key / token depend on the version of the pfSense API, see the config examples 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.
@ -17,6 +17,8 @@ Load is returned instead of cpu utilization. This is a limitation in the pfSense
Allowed fields: `["load", "memory", "temp", "wanStatus", "wanIP", "disk"]` (maximum of 4) Allowed fields: `["load", "memory", "temp", "wanStatus", "wanIP", "disk"]` (maximum of 4)
For version 2:
```yaml ```yaml
widget: widget:
type: pfsense type: pfsense
@ -29,3 +31,11 @@ widget:
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
``` ```
For version 1:
```yaml
headers: # optional, or username/password
Authorization: client_id client_token # obtained from pfSense API
version: 1
```