pfSense REST API v2.0.1

Important

This release contains an important change that prevents the package from installing on 32-bit architectures, which may result in a webConfigurator crash. This effectively restricts the package to only installing on amd64 and aarch64 architectures. This change should only affect Netgate 3100 users. It is recommended affected users remain on v1.

Fixes

• Fixes an issue where FloatField values would throw a typing error if their internal values utilized a comma-separated decimal value instead of a point decimal value. #501
• Fixes an issue where the logic of certain Model classes could prevent certain endpoints from building correctly. #501
• Fixes an issue where a Field's with a many_minimum of 0 still required allow_empty to be enabled.
• Fixes a typing error that could occur if the initial state of various config objects is an empty string instead of an array. #505

Changes

• Prevents package from being installed on 32-bit builds of pfSense. #502

Full Changelog: v2.0.0...v2.0.1

pfSense REST API v2.0.0

Important

Before installing, please refer to the v2 announcement for important information about upgrading from v1!

This release contains a major overhaul of the package. There are numerous new features, fixes, and changes. Some highlights are:

• New Framework: The REST API has been entirely rewritten including a new framework, providing a consistent experience across all endpoints while enhancing security, speed, and extensibility.
• Strict Schema: The API now enforces strict schema validation for all requests and responses, ensuring data consistency.
• Multiple Authentication Methods: Support for multiple simultaneous authentication methods.
• HATEOAS Support: HATEOAS (Hypermedia as the Engine of Application State) is now available as an opt-in feature, allowing clients to easily navigate and interact with related resources via links provided in responses.
• New Endpoints: Highly requested endpoints for WireGuard and HAProxy, along with many others, are now available in v2.
• Improved Documentation: The new framework integrates with the OpenAPI specification, enabling automatic generation of up-to-date and accurate API documentation.
• Enhanced Security Options: Notable new security features include:
  • Advanced API access list capabilities, allowing administrators to set API access rules for specific users and apply schedules to control when the API is accessible.
  • Dedicated privileges for each API endpoint and their available HTTP methods, permitting administrators to fine-tune user permissions without granting broader webConfigurator access. For more details on permissions in v2, refer to the Authorization documentation.

Full Changelog: v1.7.5...v2.0.0

pfSense REST API v2.0.0-rc-217e88f

Fixes

• Corrects some inconsistent Model construct signatures (#491)
• Restores /api/v2/firewall/nat/port_forwards endpoint (#492)
• Documentation adjustments

Full Changelog: v2.0.0-rc-30b2715...v2.0.0-rc-217e88f

pfSense API v1.7.5

Fixes

• Fixes an issue where v2 releases were seen as valid upgrade candidates for v1

Full Changelog: v1.7.4...v1.7.5

pfSense REST API v2.0.0-rc-30b2715

Important

v2 has now achieved release candidate status and is quickly approaching full release. I strongly encourage you to take this opportunity to conduct thorough testing and validate your use cases with v2. Addressing any bugs or missing features at this stage is significantly easier than post-release and will help ensure v2 sees a successful production release.

Fixes

• Fixes some unexpected behavior when updating via System > REST API > Updates and /api/v2/system/restapi/version
• Fixes issue where certain Field classes required a $many_minimum of 1 by default instead of 0.

Full Changelog: v2.0.0-rc-5e11fb2...v2.0.0-rc-30b2715

pfSense REST API v2.0.0-rc-5e11fb2

Important

v2 has now achieved release candidate status and is quickly approaching full release. I strongly encourage you to take this opportunity to conduct thorough testing and validate your use cases with v2. Addressing any bugs or missing features at this stage is significantly easier than post-release and will help ensure v2 sees a successful production release.

New

• Adds WebGUISettings Model, Endpoint and tests

Changes

• Makes various improvements and fixes to documentation
• Cleans up PHP doc strings and unused imports
• Cleans up CI/CD workflows and tests

Full Changelog: v2.0.0-beta-9824774...v2.0.0-rc-5e11fb2

pfSense REST API v2.0.0-beta-9824774

Fixes

• Fixes issue where HAProxyFrontendAction and HAProxyBackendAction could not properly determine certain fields' internal names #481
• Fixes bad internal name for HAProxyFrontend's log_detailed field
• Restores unintentionally overwritten REST API access list features
• Prevents v1 releases from showing up as valid update candidate on pfSense Plus systems

Full Changelog: v2.0.0-beta-e8cd8dd...v2.0.0-beta-9824774

pfSense REST API v2.0.0-beta-e8cd8dd

Fixes

• Allows ntpserver field to contain a maximum of 4 entries instead of 3 in DHCPServer and DHCPServerAddressPool (#475)
• Fixes an issue where providing a null value to the exact and except query filters could unintentionally cause a query match for empty values like 0.

Features

• Query filters are now extensible using the \RESTAPI\Core\QueryFilter class.

Changes

• The contains query filter now supports array values and the has query filter has subsequently been deprecated.
• Documentation improvements.

Full Changelog: v2.0.0-dev-990b919...v2.0.0-beta-e8cd8dd

pfSense API v1.7.4

Fixes

• Removes excess whitespace from the API access_list field value when saving via UI (#464)

Changes

• Adds all as a valid protocol option for POST and PUT requests to /api/v1/firewall/port_forward (#468, #469)

New Contributors

• @kheabrosec made their first contribution in #469

Full Changelog: v1.7.3...v1.7.4

pfSense REST API v2.0.0-dev-990b919

Important

We are quickly approaching a beta status for v2 as all feature commitments have been met and all automated testing is passing. For those able, please take some time to test your use cases on v2 and report any issues. A beta release is expected before the end of this month. Thanks!

New

• Improves queue/concurrency system for Dispatchers and Caches
• OpenAPI/Swagger now indicates if an endpoint applies changes immediately.
• OpenAPI/Swagger now indicates if an endpoint utilizes a Cache.
• Advanced topic 'Dispatchers and Caching' added to https://pfrest.org/DISPATCHERS_AND_CACHING/
• Improves Endpoint testing

Fixes

• Fields with many enabled now default to a minimum of 0 items in the field value.
• PUT requests to many enabled endpoints now require the request data to be an indexed array before processing.

Full Changelog: v2.0.0-dev-f207e6f...v2.0.0-dev-990b919