pfSense REST API v2.8.0

New

• New releases now trigger Ansible Collection builds to sync changes between the REST API and Ansible modules
• Adds the /api/v2/system/enum endpoint to allow clients to obtain a definitive list of options for a given model field, including dynamic options
• Adds validity information for /api/v2/system/certificate endpoints #834
• Adds the name field to /api/v2/system/table endpoints
• Adds more available fields for /api/v2/services/freeradius/user* to be more comprehensive #431, #21
• Adds /api/v2/services/freeradius/mac endpoint to add FreeRADIUS MAC entries #431, #21
• Adds /api/v2/services/freeradius/ldap endpoint to configure FreeRADIUS LDAP settings #431, #21
• Adds /api/v2/services/freeradius/eap endpoint to configure FreeRADIUS EAP settings #431, #21
• Adds /api/v2/system/update endpoint to trigger a pfSense upgrade process
• Adds new allow_development_packages REST API settings to allow development package to be used by Models/Endpoints #877
• Implements new dry_run common control parameter to allow clients check requests without actually making any changes

Fixes

• Fixes an issue that allowed /api/v2/status/system to return a CPU usage percentage over 100%
• Fixes an issue where a Model class with no Fields could result in an invalid OpenAPI schema
• Implements safe fallbacks for certificate status info

Changes

• Adds Ansible specific argument names to reserved-field names to prevent conflicts with module auto-generation
• Deprecates support for pfSense Plus < 25.11.1 and pfSense CE 2.8.0.
• Removes default sorting attribute for PortForwards

Enhancements

• Replaces various dynamic choices definitions with a choices_callable to prevent inconsistent schema choices
• Models with internal callables can now leverage pagination parameters directly #860, #806
• Improves the verbose names of models and fields throughout the entire project
• Pagination for log file endpoints has been better optimized to lower memory utilization when using pagination #860, #806
• Releases now include include schema files as release assets

New Contributors

• @guillaumearnx made their first contribution in #834
• @JeremiahChurch made their first contribution in #860

Full Changelog: v2.7.7...v2.8.0

pfSense REST API v2.8.0-dev-784d1f7

ci: correct typo in ansible collection repo name

pfSense REST API v2.7.7

New

• /api/v2/vpn/ipsec/phase2/encryption keylen field now accepts 0 as representation for auto #880

Changes

• The default maximum number of items for many (array) fields have increased from 128 to 65535 #879
• Bumps webonyx/graphql-php from 15.31.3 to 15.32.3 #875, #882
• Bumps firebase/php-jwt from 7.0.4 to 7.0.5 #881

Full Changelog: v2.7.6...v2.7.7

pfSense REST API v2.7.6

New

• Adds build for pfSense Plus 26.03

Changes

• All CI/CD Actions modules are now SHA-pinned
• Intermediate CAs are no longer deleted after the root CA is deleted
• Bumps webonyx/graphql-php from 15.30.2 to 15.31.3 #866
• Bumps firebase/php-jwt from 7.0.3 to 7.0.4 #867

Fixes

• Prevents multiple CAs from being unexpectedly deleted when one CA is deleted #873.

Full Changelog: v2.7.5...v2.7.6

pfSense REST API v2.7.5

Fixes

• Fixes an issue where Service name was unnecessarily marked as read-only
• Fixes an issue where the status of some services could not be correctly determined #863
• Fixes an issue where CRL revoked certificates with non-integer reason codes resulted in 500 errors #864

Full Changelog: v2.7.4...v2.7.5

pfSense REST API v2.7.4

New

• Adds support for Technitium DNS in ACMECertificateDomain #846
• Marks the CertificateRevocationList model's descr, lifetime and serial fields as editable #857

Fixes

• Fixes an issue that could allow an in-use CA to be deleted #856

Changes

• Bumps webonyx/graphql-php from 15.30.1 to 15.30.2
• Bumps firebase/php-jwt from 7.0.2 to 7.0.3

Full Changelog: v2.7.3...v2.7.4

pfSense REST API v2.7.3

Important

When installing on pfSense Plus 25.11 or later, you may see warnings similar to pkg-static: warning: database version 37 is newer than libpkg(3) version 36, but still compatible. This appears to be an issue with the package system on pfSense Plus 25.11+, not the package itself.

New

• Adds build for pfSense Plus 25.11.1 (#845 )

Full Changelog: v2.7.2...v2.7.3

pfSense REST API v2.7.2

New

• Adds ability to use any as interface value in FirewallRule #840

Changes

• Bumped webonyx/graphql-php from 15.29.4 to 15.30.1 #838

Full Changelog: v2.7.1...v2.7.2

pfSense REST API v2.7.1

Important

If you have not already seen the announcement for v2.7, please take some time to read through it to better understand the changes made in this release and how they may affect your integrations.

Fixes

• Fixes an issue where some installations did not correctly apply default values for new REST API settings #830 #829

Full Changelog: v2.7.0...v2.7.1

pfSense REST API v2.7.0

Important

If you have not already seen the announcement for this release, please take some time to read through it to better understand the changes made in this release and how they may affect your integrations.

New

• Implements new object caching and indexing system to improve performance on instances with large configuration sets
• Implements new query caching feature system to reduce the performance impact of redundant queries
• Implements REST API package logging facilities and configurable logging levels
• Implements basic logging for security-related events
• Adds the /api/v2/status/logs/packages/restapi endpoint for reading REST API logs
• Implements support for queries on child objects #587
• Adds new in query filter for filtering values that are within a given array or string
• Adds new /api/v2/diagnostics/ping endpoint #820
• Adds framed_ip_address and framed_ip_netmask fields to FreeRADIUSUser #767

Changes

• Makes FreeRADIUSUser's motp_enable field optional #767
• Adds no support warning for users installing the package on 32-bit systems
• Implements sane integer maximums
• UserGroup's member field now supports up to 2048 entries.
• BREAKING CHANGE: Enforces explicit DHCP server creations via POST /api/v2/services/dhcp_server instead of implicit initialization during PATCH requests

Fixes

• Fixes an issue that caused timeouts when interacting with user groups with many (1000+) members #779
• Fixes an issue that prevented system scoped user groups from being updated #822.
• Fixes an issue where the PortForward disabled value was not retained on associated firewall rules

New Contributors

• @novastate made their first contribution in #820

Full Changelog: v2.6.9...v2.7.0