pfSense REST API v2.2.0-dev-f38d613

Please refer to the announcement for more information on this development build.

pfSense REST API v2.1.2

Fixes

• Fixed an issue where an OpenVPNServer could not be assigned an authmode of Local Database. #561

Full Changelog: v2.1.1...v2.1.2

pfSense REST API v2.1.1

New

• Added the ability to assign gateway groups in DefaultGateway #558

Fixes

• Fixed an issue where the package could not accurately determine if it had an update available. #555
• Fixed an issue where the WireGuardPeer presharedkey field was not allowing empty values #541

Documentation

• Separated install commands for pfSense CE and pfSense Plus in documentation. #548

Full Changelog: v2.1.0...v2.1.1

pfSense REST API v2.1.0

New

• Adds endpoints for ACME package support #462
• Adds endpoints to gateway groups #189
• Adds endpoints for reading OpenVPN server statuses, connections and routes
• Adds endpoint for killing OpenVPN server connections
• Adds endpoints for reading OpenVPN client statuses #514
• Adds support for associated filter rules in port forward endpoints #275
• Adds format query filter to filter for values that match a specific format
• Allows DELETE requests to plural endpoints to delete objects via query #494
• Adds control parameter append to add a new item to an existing array value #517, #511
• Adds control parameter remove to remove a specific value from an existing array #517
• Adds control parameter reverse to reverse the order of objects returned by an endpoint
• Adds support for OpenAPI's deprecated directive
• Adds /api/v2/services/dhcp_server/apply endpoint

Changes

• URLContentHandler now supports more complex type inference #504
• URLContentHandler now supports parameters provided via request body #504
• DHCP server endpoints now support batching (no longer applies by default). You now must use /api/v2/services/dhcp_server/apply or the apply control parameter to apply changes.
• Status log endpoints can now read rotated logs #509
• Deprecates /api/v2/firewall/state endpoint in favor of /api/v2/firewall/states #494

Fixes

• Fixes an issue where some auxiliary interfaces were not seen as valid interface choices #536
• Fixes an issue where the WireGuardPeer::$descr field was unintentionally undefined #534
• Fixes a regression where DHCP server static mappings were not required to be within the interface's subnet #526

Performance

• Fixes a performance issue where Model's with a parent Model would reload the parent object for each child object, causing a gradual slow down as more objects were created #537
• Model::replace_all() now reuses certain ModelSets, preventing the need to reload all objects multiple times

Full Changelog: v2.0.3...v2.1.0

pfSense REST API v2.1.0-beta-5338ef4

See #544 for more details on this pre-release.

Full Changelog: v2.0.3...v2.1.0-beta-5338ef4

pfSense API v1.7.6

Changes

• Allows associated-rule-id in /api/v1/firewall/nat/port_forward to be empty string. #533
• Removes unnecessary type field from /api/v1/system/certificate. #540

New Contributors

• @Coffee-Processing-Unit made their first contribution in #542

Full Changelog: v1.7.5...v1.7.6

pfSense REST API v2.0.3

Fixes

• Fixes an issue where dependency requirements for the REST API could conflict with certain webConfigurator pages. #522
• Fixes an issue where pagination was unintentionally performed before queries. cf7eead
• Fixes a performance issue where reading all Model objects of a kind could result in each individual Model object reloading the entire set. 3fd68b7

Full Changelog: v2.0.2...v2.0.3

pfSense REST API v2.0.2

Fixes

• Fixes an issue where the authenticated user's username did not always appear correctly in change logs. #512

Full Changelog: v2.0.1...v2.0.2

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