pfSense REST API v2.4.0

Important

This release introduces some breaking changes to a few specific endpoint fields. Please review the change notes below for details to determine if your integrations will be affected before updating.

New

• Adds /api/v2/services/dhcp_relay endpoints for configuring the DHCP Relay service (#121)
• Adds support for SSL offloading in /api/v2/services/haproxy/frontend endpoints (#661)
• Adds endpoints for /api/v2/services/haproxy/frontend/certificate (#661)

Fixes

• Fixes an issue where some services' status was not accurately obtained (#634)
• Fixes an issue where the WireGuard service's enabled status was not always represented correctly
• Fixes an issue where the /api/v2/services/dhcp_server endpoints could not be used after any DHCP Relay configuration was made
• Fixes an issue where /api/v2/services/dhcp_server did not accurately determine if a DHCP Relay was running

Changes

• Makes /api/v2/services/haproxy/backend's advanced_backend field a Base64Field instead of plain StringField (#640)
  • This may be a breaking change for existing integrations! Please ensure integrations are updated to send this field as a non-base64 encoded string. The API will handle the base64 encoding/decoding for this field from now on.
• Makes /api/v2/services/bind/zone's refresh, retry, expire and minimum fields StringField's instead of IntegerFields (#653)
  • This may be a breaking change for existing integrations! Please ensure requests with these fields are now sent as strings instead of integers.
• POST requests to /api/v2/status/service now requires the id field to select the targeted service instead of name (#634, #635)
  • This may be a breaking change for existing integrations! Please ensure integrations are updated to send a numeric id instead of the service name.

New Contributors

• @colindclare made their first contribution in #661

Full Changelog: v2.3.6...v2.4.0