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

pfSense API v1.5.4

Fixes

• Fixes issue on GET /api/v1/system/certificate that unexpectedly returned the parent cert key in the data section of API responses. #357
• Fixes issue on GET /api/v1/system/ca that unexpectedly returned the parent ca key in the data section of API responses. #357
• Adds missing documentation for server_addr field on POST and PUT /api/v1/services/openvpn/client. #360

Changes

• Loosen type matching for top field on NAT rules. #352
• Bumps php-jwt dependency to v6.7.0. #356

Full Changelog: v1.5.3...v1.5.4

pfSense API v1.6.0_deved94c44

Development builds for pfSense 2.7.0-DEVELOPMENT, pfSense Plus 23.01-RELEASE and pfSense Plus 23.05-RELEASE

• Adds development build for pfSense Plus 23.05-RELEASE

pfSense API v1.5.3

Fixes

• Fixes syntax of outbound NAT mapping port ranges during creation and updates (#327, #330)

Full Changelog: v1.5.2...v1.5.3

pfSense API v1.5.2

Fixes

• Bumps php-jwt version to 6.3.2 (#305)
• Fixes issue that prevented CPU usage from being determined accurately
• Fixes issue that sometimes prevented API queries from matching correctly (#317)

Full Changelog: v1.5.1...v1.5.2

pfSense-API v1.6.0_devc01a130

Development builds for pfSense 2.7.0-DEVELOPMENT and pfSense Plus 23.01-RELEASE.

• Adds overrides/support for pfSense Plus 23.01-RELEASE
• Adds cpu_count metric to GET /api/v1/status/system

pfSense-API v1.6.0_dev04a9ad6

Development builds for pfSense 2.7.0-DEVELOPMENT and pfSense Plus 23.01-BETA.

• Fixes file overrides for pfSense Plus 23.01-BETA
• Fixes routing error that caused tests to fail prematurely.

pfSense-API v1.6.0_dev6a331a3

Development build for pfSense 2.7.0-DEVELOPMENT.

Staged Changes

• Migrates direct configuration access to new path-based configuration access introduced in pfSense 2.7.0-DEVELOPMENT.
• Updates codebase for PHP 8.1.
• Deprecates support for pfSense 2.6.0-RELEASE and earlier.
• Increases E2E testing visibility.