You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+77-1Lines changed: 77 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -53,7 +53,8 @@ After installation, you will be able to access the API user interface pages with
53
53
By default, pfSense API uses the same credentials as the webConfigurator. This behavior allows you to configure pfSense
54
54
from the API out of the box, and user passwords may be changed from the API to immediately add additional security if
55
55
needed. After installation, you can navigate to System > API in the pfSense webConfigurator to configure API
56
-
authentication.
56
+
authentication. Please note that external authentication servers like LDAP or RADIUS are not supported with any
57
+
API authentication method at this time.
57
58
58
59
To authenticate your API call, follow the instructions for your configured authentication mode:
59
60
@@ -80,6 +81,81 @@ Uses standalone tokens generated via the UI. These are better suited to distribu
80
81
pfSense API uses the same privileges as the pfSense webConfigurator. The required privileges for each endpoint are stated within the API documentation.
81
82
82
83
84
+
# Content Types
85
+
pfSense API can handle a few different content types. Please note, if a `Content-Type` header is not specified in your request pfSense API will attempt to determine the
86
+
content type which may have undesired results. It is recommended you specify your preferred `Content-Type` on each request. While several content types may be enabled,
87
+
`application/json` is the recommended content type. Supported content types are:
88
+
89
+
<details>
90
+
<summary>application/json</summary>
91
+
92
+
Parses the request body as a JSON formatted string. This is the recommended content type.
0 commit comments