Skip to content

pfSense API v1.6.0

Choose a tag to compare

View all tags
@jaredhendrickson13 jaredhendrickson13 released this 03 Jul 17:41
· 1929 commits to master since this release
v1.6.0
3cf8bee
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Verified
Learn about vigilant mode.

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

Assets 5
Loading