pfSense API v1.7.3

New

• Adds general package compatibility with pfSense Plus 24.03 #452

Fixes

• Addresses an issue where OpenVPN Client's could not be enabled/disabled after creation #451
• Adds additional safety checks when fetching API releases from GitHub #438

Full Changelog: v1.7.2...v1.7.3

pfSense API v1.7.3_deve64c61

Development build for pfSense Plus 24.03 compatibility testing.

Full Changelog: v1.7.2...v1.7.3_deve64c61dc38ba5ea57ed2a0a5295d78c43d2e2e2f

pfSense REST API v2.0.0-dev-8e34317

New

• Adds OpenVPN Client models, endpoints and tests
• Adds OpenVPN Server models, endpoints, and tests
• Adds OpenVPN Client Specific Override models, endpoints and tests
• Adds HAProxy Frontend models and endpoints
• Adds HAProxy Backend models and endpoints
• Adds HAProxy File models and endpoints
• Adds HAProxy Settings model, endpoints and tests
• Adds HAProxy Apply model, endpoints, dispatcher and tests

Changes

• The DHCPServer model automatically initializes interfaces eligible for a DHCP Server if missing from config.
• Includes improved testing for OpenVPN interfaces in rdr rules

Fixes

• Corrects some typos and formatting throughout the package.

Full Changelog: v2.0.0-dev-cbc8ea0...v2.0.0-dev-8e34317

pfSense API v1.7.2

Fixes

• Fixes top sorting for NAT rules (#449)
• /api/v1/services/ipsec/phase2 no longer requires a hash-algorithm-option when GCM/CHACHA20-POLY1305 encryption is used (#448)

New Contributors

• @zsxsoft made their first contribution in #449

Full Changelog: v1.7.1...v1.7.2

pfSense REST API v2.0.0-dev-094eefe

New

• Adds WireGuard tunnel, peer, and settings models, endpoints and tests.
• Allows multiple authentication methods to be enabled at once.
• Adds Authentication Server models, endpoints and tests.
• Adds 1:1 NAT mapping model, endpoints and tests.
• Adds DHCP server static mapping model, endpoints and tests.
• Adds DHCP server address pool model, endpoints and tests.
• Adds DHCP server backend model, endpoint and tests.
• Adds Default Gateway model, endpoint and tests.
• Adds NTP server models, endpoints and tests.
• Adds Firewall States model, endpoint and tests.
• Adds Service Watchdog model, endpoint and tests.
• Adds System Status model, endpoint and tests.
• Adds Traffic Shaper Limiter models, endpoints and tests.

Fixes

• Fixes conflict that caused errors when both the v1 and v2 packages are installed on the same system. #442
• Minor fixes to automation UI form generation.
• Minor adjustments to auto OpenAPI documentation generation to enforce consistency.
• Various other performance and bug fixes.

Full Changelog: v2.0.0-dev-4daf959...v2.0.0-dev-094eefe

pfSense REST API v2.0.0-dev-4daf959

Please refer to the announcement for more details regarding v2.

Changes

• Restructures package contents to better match other pfSense package structures.
• Makes HATEOAS an opt-in feature instead of enabling by default.

Fixes

• Fixes issue that caused dependency conflicts with php-jwt when running both v1 and v2 on the same system.
• Various bug fixes and framework improvements.

New

• Introduces Cache class to establish a standardized way to cache data.
• Introduces ContentHandler class to establish a standardized way to encode and decode content for various MIME-types.
• Adds TrafficShaper model, endpoints and tests.
• Adds TrafficShaperQueue model, endpoints and tests
• Adds SystemHalt model, endpoint and tests.
• Adds SystemReboot model, endpoint, and tests.
• Adds FirewallSchedule model, endpoint and tests.
• Adds FirewallScheduleTimeRange model, endpoint and tests.
• Adds CronJob model, endpoint and tests.
• Adds SystemPackage model, endpoint and tests.
• Adds AvailablePackage model, endpoint and tests.
• Adds SystemConsole model, endpoint and tests.
• Adds RESTAPISettingsSync model, endpoint and tests.
• Adds new UIDField and FloatField classes.

Full Changelog: v2.0.0-dev-cbc8ea0...v2.0.0-dev-4daf959

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