pfSense REST API v2.0.0-dev-990b919

Important

We are quickly approaching a beta status for v2 as all feature commitments have been met and all automated testing is passing. For those able, please take some time to test your use cases on v2 and report any issues. A beta release is expected before the end of this month. Thanks!

New

• Improves queue/concurrency system for Dispatchers and Caches
• OpenAPI/Swagger now indicates if an endpoint applies changes immediately.
• OpenAPI/Swagger now indicates if an endpoint utilizes a Cache.
• Advanced topic 'Dispatchers and Caching' added to https://pfrest.org/DISPATCHERS_AND_CACHING/
• Improves Endpoint testing

Fixes

• Fields with many enabled now default to a minimum of 0 items in the field value.
• PUT requests to many enabled endpoints now require the request data to be an indexed array before processing.

Full Changelog: v2.0.0-dev-f207e6f...v2.0.0-dev-990b919

pfSense REST API v2.0.0-dev-f207e6f

Important

We are quickly approaching a beta status for v2 as all feature commitments have been met and all automated testing is passing. For those able, please take some time to test your use cases on v2 and report any issues. A beta release is expected before the end of this month. Thanks!

New

• Adds DHCPServerCustomOption model, endpoint and tests
• Adds DHCPServerLease model, endpoint and tests
• Adds InterfaceStats model, endpoint and tests
• Adds AvailableInterface model, endpoint and tests
• Adds /api/v2/firewall/virtual_ip/apply endpoint
• Adds a non-interactive version of the Swagger API docs at https://pfrest.org/api-docs/

Changes

• The package's PHP reference docs have moved to https://pfrest.org/php-docs/
• Various changes and improvements to documentation site

Fixes

• Fixes OpenAPI schema errors
• Fixes an issue where some PortField's had their default set to an integer instead of a string.
• Fixes an issue where some many enabled Model Fields use a primitive value type as its default instead of an array default.
• Fixes DHCPServer::replace_all()/PUT /api/v2/services/dhcp_servers so they are applied with the correct IDs.

Full Changelog: v2.0.0-dev-1bd5e5a...v2.0.0-dev-f207e6f

pfSense REST API v2.0.0-dev-1bd5e5a

Important

We are quickly approaching a beta status for v2 as all feature commitments have been met and all automated testing is passing. For those able, please take some time to test your use cases on v2 and report any issues. A beta release is expected before the end of this month. Thanks!

Features

• Adds model, endpoint and tests for FirewallAdvancedSettings
• Adds models endpoints and tests for DNSForwarderHostOverride
• Adds model, endpoint and tests for DNSForwarderApply
• pfSense-pkg-RESTAPI guide now available at https://pfrest.org
• pfSense-pkg-RESTAPI codebase documentation now available at https://pfrest.org/php_reference/

Fixes

• Fixes issue where package could not see webConfigurator CSS settings #463
• Fixes issue where HAProxyFrontendACL and HAProxyBackendACL models unnecessarily required the name field to be unique.

Full Changelog: v2.0.0-dev-cf724fd...v2.0.0-dev-1bd5e5a

pfSense REST API v2.0.0-dev-cf724fd

New

• Adds /api/v2/services/dns_resolver/domain_override endpoint and model
• Adds /api/v2/services/dns_resolver/settings endpoint and model
• Adds /api/v2/system/notifications/email_settings endpoint and model
• Adds /api/v2/status/logs/system endpoint and model
• Adds /api/v2/status/logs/dhcp endpoint and model
• Adds /api/v2/status/logs/firewall endpoint and model
• Adds /api/v2/system/crl endpoint and model
• Adds various apply endpoints
• Package PHP development documentation site now available at jaredhendrickson13.github.io/pfsense-api

Changes

• OpenAPI schema is now at /api/v2/schema
• Swagger documentation site is now at /api/v2/documentation
• KeyAuth now uses x-api-key header instead of authorization header.
• Routing endpoint URLs have been simplified to /api/v2/routing/*

Fixes

• Allows empty values in HAProxyBackend balance field
• Fixes KeyAuth authentication in Swagger documentation site

CI

• Includes workflows to build package PHP development documentation site
• Includes OpenAPI schema checks

Full Changelog: v2.0.0-dev-8e34317...v2.0.0-dev-cf724fd

pfSense API v1.7.3

New

• Adds general package compatibility with pfSense Plus 24.03 #452

Fixes

• Addresses an issue where OpenVPN Client's could not be enabled/disabled after creation #451
• Adds additional safety checks when fetching API releases from GitHub #438

Full Changelog: v1.7.2...v1.7.3

pfSense API v1.7.3_deve64c61

Development build for pfSense Plus 24.03 compatibility testing.

Full Changelog: v1.7.2...v1.7.3_deve64c61dc38ba5ea57ed2a0a5295d78c43d2e2e2f

pfSense REST API v2.0.0-dev-8e34317

New

• Adds OpenVPN Client models, endpoints and tests
• Adds OpenVPN Server models, endpoints, and tests
• Adds OpenVPN Client Specific Override models, endpoints and tests
• Adds HAProxy Frontend models and endpoints
• Adds HAProxy Backend models and endpoints
• Adds HAProxy File models and endpoints
• Adds HAProxy Settings model, endpoints and tests
• Adds HAProxy Apply model, endpoints, dispatcher and tests

Changes

• The DHCPServer model automatically initializes interfaces eligible for a DHCP Server if missing from config.
• Includes improved testing for OpenVPN interfaces in rdr rules

Fixes

• Corrects some typos and formatting throughout the package.

Full Changelog: v2.0.0-dev-cbc8ea0...v2.0.0-dev-8e34317

pfSense API v1.7.2

Fixes

• Fixes top sorting for NAT rules (#449)
• /api/v1/services/ipsec/phase2 no longer requires a hash-algorithm-option when GCM/CHACHA20-POLY1305 encryption is used (#448)

New Contributors

• @zsxsoft made their first contribution in #449

Full Changelog: v1.7.1...v1.7.2

pfSense REST API v2.0.0-dev-094eefe

New

• Adds WireGuard tunnel, peer, and settings models, endpoints and tests.
• Allows multiple authentication methods to be enabled at once.
• Adds Authentication Server models, endpoints and tests.
• Adds 1:1 NAT mapping model, endpoints and tests.
• Adds DHCP server static mapping model, endpoints and tests.
• Adds DHCP server address pool model, endpoints and tests.
• Adds DHCP server backend model, endpoint and tests.
• Adds Default Gateway model, endpoint and tests.
• Adds NTP server models, endpoints and tests.
• Adds Firewall States model, endpoint and tests.
• Adds Service Watchdog model, endpoint and tests.
• Adds System Status model, endpoint and tests.
• Adds Traffic Shaper Limiter models, endpoints and tests.

Fixes

• Fixes conflict that caused errors when both the v1 and v2 packages are installed on the same system. #442
• Minor fixes to automation UI form generation.
• Minor adjustments to auto OpenAPI documentation generation to enforce consistency.
• Various other performance and bug fixes.

Full Changelog: v2.0.0-dev-4daf959...v2.0.0-dev-094eefe

pfSense REST API v2.0.0-dev-4daf959

Please refer to the announcement for more details regarding v2.

Changes

• Restructures package contents to better match other pfSense package structures.
• Makes HATEOAS an opt-in feature instead of enabling by default.

Fixes

• Fixes issue that caused dependency conflicts with php-jwt when running both v1 and v2 on the same system.
• Various bug fixes and framework improvements.

New

• Introduces Cache class to establish a standardized way to cache data.
• Introduces ContentHandler class to establish a standardized way to encode and decode content for various MIME-types.
• Adds TrafficShaper model, endpoints and tests.
• Adds TrafficShaperQueue model, endpoints and tests
• Adds SystemHalt model, endpoint and tests.
• Adds SystemReboot model, endpoint, and tests.
• Adds FirewallSchedule model, endpoint and tests.
• Adds FirewallScheduleTimeRange model, endpoint and tests.
• Adds CronJob model, endpoint and tests.
• Adds SystemPackage model, endpoint and tests.
• Adds AvailablePackage model, endpoint and tests.
• Adds SystemConsole model, endpoint and tests.
• Adds RESTAPISettingsSync model, endpoint and tests.
• Adds new UIDField and FloatField classes.

Full Changelog: v2.0.0-dev-cbc8ea0...v2.0.0-dev-4daf959