pfSense API v1.7.1

Fixes

• Addresses a webConfigurator crash that could occur if GitHub's releases API did not respond as expected and/or the releases cache file became polluted. (#438)

Full Changelog: v1.7.0...v1.7.1

pfSense REST API v2.0.0-dev-cbc8ea0

Please refer to the announcement for more details regarding v2.

New

• Adds IPsecPhase1 model, endpoints and tests.
• Adds IPsecPhase1Encryption model, endpoints and tests.
• Adds IPsecPhase2 model, endpoints and tests.
• Adds IPsecPhsse2Encryption model, endpoints and tests.
• Adds WakeOnLANSend model, endpoint and tests.
• Form classes now automatically generate pfSense privileges for their respective web pages.

Fixes

• Fixes an issue where endpoints would throw a server error if pagination parameters limit and offset were not provided
• Fixes an issue where Models with parent_id's could not be constructed outside of the data parameter.
• Addresses minor bugs and optimizations.

pfSense REST API v2.0.0-dev-3982522

This pre-release contains the initial development build for REST API v2. Please refer to the announcement for more details.

pfSense API v1.7.0

IMPORTANT: This release contains fixes for changes introduced in pfSense 2.7.1. These changes are not fully compatible with pfSense 2.7.0. It is recommended pfSense 2.7.0 users remain on v1.6.x until they are able to update to pfSense 2.7.1 or later.

Fixes

• Addresses changed field names for outbound NAT mappings in pfSense 2.7.1+.
• Minor corrections for API responses.
• Minor build and test fixes.

Changes

• Bumps php-jwt to v6.10.0
• Updates APIInterfaceApplyCreate model to use new pfSense 2.7.1 functions.

New Contributors

• @punk-t made their first contribution in #418

Full Changelog: v1.6.5...v1.7.0

pfSense API v1.6.5

Fixes

• Addresses an issue where PUT requests to /api/v1/system/config did not replace the configuration as expected #405

Changes

• Bumps php-jwt to v6.9.0

Full Changelog: v1.6.4...v1.6.5

pfSense API v1.6.4

Fixes

• Improves input validation for the pfsense-api revert command
• Addresses an issue where the select target version was not properly escaped before initiating package updates from /api/updates/

Full Changelog: v1.6.3...v1.6.4

pfSense API v1.6.3

Fixes

• Fixes issue where API version comparisons for available updates failed on PHP 8. #390
• Fixes issue where a blank alias address detail was added when adding the first alias address entry. #395

Changes

• Package builds are no longer architecture specific. #393

New Contributors

• @elacy made their first contribution in #393

Full Changelog: v1.6.2...v1.6.3

pfSense API v1.6.2

Fixes

• Fixes issue where API sync with no headers threw fatal errors (#380)
• Relaxes input validation for remote-gateway field on /api/v1/services/ipsec/phase1 (#382)
• Fixes an issue where client were unable to obtain access tokens via API without page-all privileges (#384)
• Fixes an issue where an error was thrown when attempting to create new outbound NAT mappings when no mappings exist initially (#385)

Full Changelog: v1.6.1...v1.6.2

pfSense API v1.6.1

Fixes

• Fixes issue with POST /api/v1/firewall/alias/entry that allowed an extra alias detail item to be appended. #374

Changes

• Uses pkg-static for API version lookups instead of pkg. #373
• Bumps php-jwt to v6.8.1. #379

Full Changelog: v1.6.0...v1.6.1

pfSense API v1.6.0

Important! This release contains a refactor required for compatibility with pfSense CE 2.7.0+ and pfSense Plus 23.01+. In addition to this refactor, this release contains some potentially breaking changes which are highlighted below.

Removes

• Request body authentication has been deprecated. All credentials must be passed via header. Refer to the documentation for more info.
• Deprecates support for pfSense CE <=2.6.0 and pfSense Plus <=22.05. The changes necessary for FreeBSD 14 and PHP 8.2 are not backwards compatible.

Refactors

• Refactors codebase to use new path based config references introduced in pfSense 2.7.0/pfSense Plus 23.01.
• Refactors codebase for PHP 8.2.
• Refactors package Makefile and plist for builds on FreeBSD 14.
• The online field on /api/v1/status/dhcpd/lease no longer returns a boolean value, now returns a string indicating the exact online status of the lease. (#340)

New

• Adds ability to opt-in to pre-releases from the API update page.
• Adds ability to create floating rules with no interface assignment. (#301)
• Allows interface groups, IPsec and OpenVPN interfaces to be used in port forwards (#336, #333)
• Allow PUT method to /api/v1/services/unbound to update select general DNS Resolver options (#313)

Fixes

• Overall performance and stability improvements.
• Several documentation adjustments and corrections.
• Fixes incorrect permission names and assignments. (#292).
• The monitor field now gets unset when monitor_disable is set to true on /api/v1/routing/gateway.
• Fixes an issue where package installation/updates fail on pfSense Plus due to failed certificate verification. Refer to the documentation for more information on the update installation command. (#334)

CI & Testing

• Moves build and E2E test workflows from private Jenkins to GitHub Actions.
• All endpoint permissions are covered by E2E tests.
• E2E tests now verify select backend services are configured to expectation, not just the pfSense XML configuration.

Full Changelog: v1.5.4...v1.6.0