Skip to content

pfSense REST API v2.1.0

Compare
Choose a tag to compare
@jaredhendrickson13 jaredhendrickson13 released this 30 Aug 22:56
· 271 commits to master since this release
291fff6

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