pfSense REST API v2.0.0

Important

Before installing, please refer to the v2 announcement for important information about upgrading from v1!

This release contains a major overhaul of the package. There are numerous new features, fixes, and changes. Some highlights are:

• New Framework: The REST API has been entirely rewritten including a new framework, providing a consistent experience across all endpoints while enhancing security, speed, and extensibility.
• Strict Schema: The API now enforces strict schema validation for all requests and responses, ensuring data consistency.
• Multiple Authentication Methods: Support for multiple simultaneous authentication methods.
• HATEOAS Support: HATEOAS (Hypermedia as the Engine of Application State) is now available as an opt-in feature, allowing clients to easily navigate and interact with related resources via links provided in responses.
• New Endpoints: Highly requested endpoints for WireGuard and HAProxy, along with many others, are now available in v2.
• Improved Documentation: The new framework integrates with the OpenAPI specification, enabling automatic generation of up-to-date and accurate API documentation.
• Enhanced Security Options: Notable new security features include:
  • Advanced API access list capabilities, allowing administrators to set API access rules for specific users and apply schedules to control when the API is accessible.
  • Dedicated privileges for each API endpoint and their available HTTP methods, permitting administrators to fine-tune user permissions without granting broader webConfigurator access. For more details on permissions in v2, refer to the Authorization documentation.

Full Changelog: v1.7.5...v2.0.0