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

pfSense REST API v2.3.6

Fixes

• Fixes a bad function reference that resulted in a 500 error on /api/v2/status/ipsec/child_sa (#664)

Full Changelog: v2.3.5...v2.3.6

pfSense REST API v2.3.5

Fixes

• Fixes an issue where users could not access REST API webConfigurator pages as expected with specific privileges (#658)
• Minor privilege description adjustments

Full Changelog: v2.3.4...v2.3.5

pfSense REST API v2.3.4

Fixes

• Fixes an issue where PortForwards with associated rules were not created/updated correctly (#659)
• Fixes an issue where client information in the FirewallRule created_by and updated_by fields were not passed to new objects during PUT requests
• Relaxes FirewallAlias validation that prevented nested aliases of different types

Full Changelog: v2.3.3...v2.3.4

pfSense REST API v2.3.3

Fixes

• Fixes an issue where some GraphQL clients could not load the GraphQL schema for introspection #623
• Fixes an issue where StaticRoute objects could not be updated after creation until they were applied #654
• Minor error message adjustments

New

• Clients can now select sort flags #646

Changes

• Increases OpenVPNServer local_networks limit #644
• DHCPStaticMapping now uses natural sorting by default #639, #646

Full Changelog: v2.3.2...v2.3.3

pfSense REST API v2.3.2

New

• Adds create_gw field to OpenVPNClient #642
• Improves error handling during package updates #633
• Allows implicit gateways to be used in FirewallRule gateway field #636

Fixes

• Allows RSA private keys in Certificate prv field #638

Full Changelog: v2.3.1...v2.3.2

pfSense REST API v2.3.1

Fixes

• Restores missing server_port field in OpenVPNClient (#622)
• Fixes an issue where the deletion of a REST API key or access list via UI forced users to logout (#630)

New Contributors

• @AlexTrushkovsky made their first contribution in #622

Full Changelog: v2.3.0...v2.3.1

pfSense API v1.8.0

Note

This release brings basic support for pfSense Plus 24.11 and other bug fixes. While testing suggests this build is stable on pfSense Plus 24.11, it is still recommended you take a ZFS snapshot before upgrading to pfSense Plus 24.11 and installing the package. Unlike pfSense CE, compatibility between this package and pfSense Plus greatly depends on the community. If you experience any compatibility issues with this package on pfSense Plus 24.11, please open an issue.

New

• Adds support for pfSense Plus 24.11 (#610, #611)

Fixes

• Addresses an issue where the /api/v1/system/certificate endpoint's active field was being ignored.
• Fixes minor build issues on FreeBSD 15.

Full Changelog: v1.7.6...v1.8.0

pfSense REST API v2.3.0

Note

This release brings basic support for pfSense Plus 24.11, some new features and other bug fixes. While testing suggests this build is stable on pfSense Plus 24.11, it is still recommended you take a ZFS snapshot before upgrading to pfSense Plus 24.11 and installing the package. Unlike pfSense CE, compatibility between this package and pfSense Plus greatly depends on the community. If you experience any compatibility issues with this package on pfSense Plus 24.11, please open an issue.

New

• Adds support for pfSense Plus 24.11 (#610, #611)
• Adds new endpoints and model for managing LAGG interfaces (#615)
• Adds new endpoints and model for managing GRE tunnel interfaces (#156)
• Adds support for the CARP unicast mode on pfSense Plus (#424)

Fixes

• Fixes an issue that prevented the packaged from determining a user's assigned privileges on pfSense Plus 24.11 (#610, #611)
• Fixes minor build issues on FreeBSD 15
• Fixes numerous issues with invalid configuration accessors on pfSense 24.11 (#610, #611)
• Fixes an issue that caused all NetworkInterface objects to be reloaded during each DHCPServer object construction
• Fixes an issue that could result in the PHP memory limit being exceeded when Model objects were serialized (#616, #617)
• Removes the required attribute from the CertificateAuthrority's prv field (#605)
• Fixes an issue that prevented Certificates from being relinked to their CertificateAuthority during import (#605)
• Fixes an issue in the GatewayGroup model that could result in a error being raised if a gateway was assigned that is not actively in config (#603)
• Fixes an issue that prevented nested aliases from being used as address values in PUT /api/v2/firewall/aliases (#619)

New Contributors

• @war59312 made their first contribution in #613

Full Changelog: v2.2.2...v2.3.0

pfSense API v1.8.0-dev-aa40a2c

Important

This is a very early build that only contains very minimal changes to allow the package to be installed and operate at a fundamental level on pfSense Plus 24.11. There are still bugs and other issues present that need to be addressed before it can be considered stable on pfSense Plus 24.11. Testing from the community is needed!

New

• Implements basic compatibility with pfSense Plus 24.11. (#610, #611)

Full Changelog: v1.7.6...v1.8.0-dev-aa40a2c