Skip to content

pfSense REST API v2.8.0

Latest

Choose a tag to compare

@jaredhendrickson13 jaredhendrickson13 released this 16 May 19:00
· 3 commits to master since this release
408e206

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

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