Skip to content

Commit 2b51600

Browse files
updated readme
1 parent 5b84b56 commit 2b51600

1 file changed

Lines changed: 6 additions & 7 deletions

File tree

README.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
pfSense API
2-
===========
1+
---
32
# Introduction
43
pfSense API is a fast, safe, full-fledged API based on REST architecture. This works by leveraging the same PHP functions and processes used by pfSense's webConfigurator into API endpoints to create, read, update and delete pfSense configurations. All API endpoints enforce input validation to prevent invalid configurations from being made. Configurations made via API are properly written to the master XML configuration and the correct backend configurations are made preventing the need for a reboot. All this results in the fastest, safest, and easiest way to automate pfSense!
54

@@ -10,21 +9,21 @@ To install pfSense API, simply run the following command from the pfSense shell:
109
To uninstall, run the following command:<br>
1110
`pkg delete pfSense-pkg-API`<br>
1211

13-
_Note: if you do not shell access to pfSense, you can install via the webConfigurator by navigating to 'Diagnostics > Command Prompt' and enter the commands there_
12+
_Note: if you do not have shell access to pfSense, you can still install via the webConfigurator by navigating to 'Diagnostics > Command Prompt' and enter the commands there_
1413

1514
# Requirements
16-
- pfSense 2.4.4 or later is required
15+
- pfSense 2.4.4 or later is supported
1716
- pfSense API requires a local user account in pfSense. The same permissions required to make configurations in the webConfigurator are required to make calls to the API endpoints
18-
- While not an enforced requirement, it is STRONGLY recommended that you configure pfSense to use HTTPS instead of HTTP
17+
- While not an enforced requirement, it is STRONGLY recommended that you configure pfSense to use HTTPS instead of HTTP. This ensures that login credentials and/or API tokens remain secure in-transit
1918

2019
# Authentication
2120
By default, pfSense API uses the same credentials as the webConfigurator. Alternatively, you can configure pfSense API to create secure API client IDs and tokens for API users. To generate, or delete API keys you can navigate to `System > API` in the UI after installation, and change the authentication mode to `API Token`.
2221

2322
# Response Codes
2423
`200 (OK)` : API call succeeded<br>
25-
`400 (Bad Request)` : There was an error with your requested parameters<br>
24+
`400 (Bad Request)` : An error was found within your requested parameters<br>
2625
`401 (Unauthorized)` : API client has not completed authentiation or authorization successfully<br>
27-
`403 (Forbidden)` : The API endpoint has refused your call<br>
26+
`403 (Forbidden)` : The API endpoint has refused your call. Commonly due to your access settings found in `System > API`<br>
2827
`404 (Not found)` : Either the API endpoint or requested data was not found<br>
2928
`500 (Server error)` : The API endpoint encountered an unexpected error processing your API request<br>
3029

0 commit comments

Comments
 (0)