Skip to content

Commit b2cda02

Browse files
Minor adjustments to documentation
1 parent 02dccf1 commit b2cda02

3 files changed

Lines changed: 12 additions & 11 deletions

File tree

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ webConfigurator are required to make calls to the API endpoints
2121
# Installation
2222
To install pfSense API, simply run the following command from the pfSense shell:<br>
2323
```
24-
pkg add https://github.com/jaredhendrickson13/pfsense-api/releases/latest/download/pfSense-2.4-pkg-API.txz && /etc/rc.restart_webgui
24+
pkg add https://github.com/jaredhendrickson13/pfsense-api/releases/latest/download/pfSense-2.5-pkg-API.txz && /etc/rc.restart_webgui
2525
```
2626

2727
To uninstall pfSense API, run the following command:<br>
@@ -36,11 +36,11 @@ pfsense-api update
3636

3737
To revert to a previous version of pfSense API (e.g. v1.0.2), run the following command:
3838
```
39-
pfsense-api revert v1.0.2
39+
pfsense-api revert v1.1.7
4040
```
4141

4242
### Notes:
43-
- pfSense API is supported on the pfSense 2.5 developer snapshots. To install the 2.5 package, simply change the `2.4` in the install URL to `2.5`.
43+
- To install the 2.4 package, simply change the `2.5` in the install URL to `2.4`.
4444
- In order for pfSense to apply some required web server changes, it is required to restart the webConfigurator after installing the package
4545
- If you do not have shell access to pfSense, you can still install via the webConfigurator by navigating to
4646
'Diagnostics > Command Prompt' and enter the commands there
@@ -6817,3 +6817,4 @@ URL: https://{{$hostname}}/api/v1/user/privilege
68176817

68186818
---
68196819
[Back to top](#pfsense-rest-api-documentation)
6820+
> Made with &#9829; by [thedevsaddam](https://github.com/thedevsaddam) | Generated at: 2021-03-14 22:47:05 by [docgen](https://github.com/thedevsaddam/docgen)

0 commit comments

Comments
 (0)