pfSense REST API v2.5.0

New

• Adds full support for pfSense CE 2.8.0-RELEASE
• Adds new /api/v2/status/logs/auth endpoint
• Adds new /api/v2/status/logs/openvpn endpoint
• Adds new /api/v2/services/freeradius/user endpoints #701 #21 (Thanks @vitspec99 !)
• Adds advanced field to HAProxyBackendServer #682
• Adds descr field to WireGuardTunnel #705
• Improved file cleanup process when package is deleted

Changes

• Removes support for pfSense CE 2.7.2 and pfSense Plus 24.03
• Potential breaking change: OpenVPNServer remove_route field has been replaced with remove_options
  • remove_options is an array of strings and must match redefined choices. Refer to the API documentation for more info.

Fixes

• Fixes button icons in UI form pages #620
• Fixes incompatibilities with new pfSense cert* function schemas
• Fixes an issue where ConfigHistoryRevision contained invalid file sizes
• Adds additional normalization to config paths to prevent unexpected read/writes
• Fixes an issue where the User password field could fail to create a hash on pfSense Plus
• Adjusts schedule for AvailablePackageCache to help prevent conflicts with other repo tasks #700
• Various other fixes and improvements for pfSense Plus 24.11

New Contributors

• @vitspec99 made their first contribution in #698

Full Changelog: v2.4.2...v2.5.0

pfSense REST API v2.4.3

Note

This release back ports some of the fixes and enhancements made in v2.5.0 for users who are currently unable to update to pfSense CE 2.8.0 yet.

New

• Adds advanced field to HAProxyBackendServer #682
• Adds descr field to WireGuardTunnel #705

Fixes

• Adjusts schedule for AvailablePackageCache to help prevent conflicts with other repo tasks #700

Full Changelog: v2.4.2...v2.4.3

pfSense REST API v2.5.0-dev-47c972e

Warning

This is a late stage development build for pfSense CE 2.8.0. It is intended for testing purposes only.

New

• Revised development build with compatibility for pfSense-2.8.0-RELEASE

Full Changelog: v2.4.2...v2.5.0-dev-47c972e

pfSense REST API v2.4.2

Fixes

• Fixes an issue that prevent DNSResolverSettings from determining python_script choices (#681)

Full Changelog: v2.4.1...v2.4.2

pfSense REST API v2.5.0-dev-e8da943

Warning

This pre-release primarily includes a very early build for pfSense CE 2.8.0. There are numerous known issues that are actively being worked on. Only run this build for development and testing purposes.

New

• Adds early build for pfSense-2.8.0-BETA

pfSense REST API v2.4.1

Fixes

• Fixes an issue that prevented HAProxyFrontends from being applied (#677, thanks @colindclare!)

Full Changelog: v2.4.0...v2.4.1

pfSense REST API v2.4.0

Important

This release introduces some breaking changes to a few specific endpoint fields. Please review the change notes below for details to determine if your integrations will be affected before updating.

New

• Adds /api/v2/services/dhcp_relay endpoints for configuring the DHCP Relay service (#121)
• Adds support for SSL offloading in /api/v2/services/haproxy/frontend endpoints (#661)
• Adds endpoints for /api/v2/services/haproxy/frontend/certificate (#661)

Fixes

• Fixes an issue where some services' status was not accurately obtained (#634)
• Fixes an issue where the WireGuard service's enabled status was not always represented correctly
• Fixes an issue where the /api/v2/services/dhcp_server endpoints could not be used after any DHCP Relay configuration was made
• Fixes an issue where /api/v2/services/dhcp_server did not accurately determine if a DHCP Relay was running

Changes

• Makes /api/v2/services/haproxy/backend's advanced_backend field a Base64Field instead of plain StringField (#640)
  • This may be a breaking change for existing integrations! Please ensure integrations are updated to send this field as a non-base64 encoded string. The API will handle the base64 encoding/decoding for this field from now on.
• Makes /api/v2/services/bind/zone's refresh, retry, expire and minimum fields StringField's instead of IntegerFields (#653)
  • This may be a breaking change for existing integrations! Please ensure requests with these fields are now sent as strings instead of integers.
• POST requests to /api/v2/status/service now requires the id field to select the targeted service instead of name (#634, #635)
  • This may be a breaking change for existing integrations! Please ensure integrations are updated to send a numeric id instead of the service name.

New Contributors

• @colindclare made their first contribution in #661

Full Changelog: v2.3.6...v2.4.0

pfSense REST API v2.3.6

Fixes

• Fixes a bad function reference that resulted in a 500 error on /api/v2/status/ipsec/child_sa (#664)

Full Changelog: v2.3.5...v2.3.6

pfSense REST API v2.3.5

Fixes

• Fixes an issue where users could not access REST API webConfigurator pages as expected with specific privileges (#658)
• Minor privilege description adjustments

Full Changelog: v2.3.4...v2.3.5

pfSense REST API v2.3.4

Fixes

• Fixes an issue where PortForwards with associated rules were not created/updated correctly (#659)
• Fixes an issue where client information in the FirewallRule created_by and updated_by fields were not passed to new objects during PUT requests
• Relaxes FirewallAlias validation that prevented nested aliases of different types

Full Changelog: v2.3.3...v2.3.4