pfSense API v1.7.5

Fixes

• Fixes an issue where v2 releases were seen as valid upgrade candidates for v1

Full Changelog: v1.7.4...v1.7.5

pfSense REST API v2.0.0-rc-30b2715

Important

v2 has now achieved release candidate status and is quickly approaching full release. I strongly encourage you to take this opportunity to conduct thorough testing and validate your use cases with v2. Addressing any bugs or missing features at this stage is significantly easier than post-release and will help ensure v2 sees a successful production release.

Fixes

• Fixes some unexpected behavior when updating via System > REST API > Updates and /api/v2/system/restapi/version
• Fixes issue where certain Field classes required a $many_minimum of 1 by default instead of 0.

Full Changelog: v2.0.0-rc-5e11fb2...v2.0.0-rc-30b2715

pfSense REST API v2.0.0-rc-5e11fb2

Important

v2 has now achieved release candidate status and is quickly approaching full release. I strongly encourage you to take this opportunity to conduct thorough testing and validate your use cases with v2. Addressing any bugs or missing features at this stage is significantly easier than post-release and will help ensure v2 sees a successful production release.

New

• Adds WebGUISettings Model, Endpoint and tests

Changes

• Makes various improvements and fixes to documentation
• Cleans up PHP doc strings and unused imports
• Cleans up CI/CD workflows and tests

Full Changelog: v2.0.0-beta-9824774...v2.0.0-rc-5e11fb2

pfSense REST API v2.0.0-beta-9824774

Fixes

• Fixes issue where HAProxyFrontendAction and HAProxyBackendAction could not properly determine certain fields' internal names #481
• Fixes bad internal name for HAProxyFrontend's log_detailed field
• Restores unintentionally overwritten REST API access list features
• Prevents v1 releases from showing up as valid update candidate on pfSense Plus systems

Full Changelog: v2.0.0-beta-e8cd8dd...v2.0.0-beta-9824774

pfSense REST API v2.0.0-beta-e8cd8dd

Fixes

• Allows ntpserver field to contain a maximum of 4 entries instead of 3 in DHCPServer and DHCPServerAddressPool (#475)
• Fixes an issue where providing a null value to the exact and except query filters could unintentionally cause a query match for empty values like 0.

Features

• Query filters are now extensible using the \RESTAPI\Core\QueryFilter class.

Changes

• The contains query filter now supports array values and the has query filter has subsequently been deprecated.
• Documentation improvements.

Full Changelog: v2.0.0-dev-990b919...v2.0.0-beta-e8cd8dd

pfSense API v1.7.4

Fixes

• Removes excess whitespace from the API access_list field value when saving via UI (#464)

Changes

• Adds all as a valid protocol option for POST and PUT requests to /api/v1/firewall/port_forward (#468, #469)

New Contributors

• @kheabrosec made their first contribution in #469

Full Changelog: v1.7.3...v1.7.4

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