pfSense API v1.4.1

New

• Adds /api/v1/interface/available endpoint to read details on all interfaces available to the system. (#216)
• Adds /api/v1/services/unbound/host_override/flush endpoint to delete all existing host overrides from the DNS Resolver.

Fixes

• Fixes favicons within API documentation to correctly display pfSense native icons.
• Fixes bug that prevented API package from being updated on pfSense Plus.
• Fixes bug that prevented menu items from being installed for packages installed via /api/v1/system/package.
• Fixes bug that allowed certificates to be updated without specifying a refid value on PUT requests to /api/v1/system/certificate.
• Fixes bug that prevented updated certificates from being stored in the required Base64 format on PUT requests to /api/v1/system/certificate (#218, #219)

Removes

• Removes ability to install packages via external URLs using /api/v1/system/package. Use the /api/v1/diagnostics/command_prompt endpoint to do this going forward.

Full Changelog: v1.4.0...v1.4.1

pfSense API v1.4.0

New

• Adds support for pfSense Plus 22.01.*
• Adds API access list to restrict which IPs can interact with the API.
• Adds numberoptions, defaultleasetime and maxleasetime to /api/v1/services/dhcpd. (#176)
• Adds /api/v1/services/dhcpd/options endpoint to add DHCP options.
• Adds support for DELETE requests to /api/v1/firewall/states to kill firewall states. (#160)
• Adds /api/v1/firewall/rule/sort endpoint to sort firewall rules based on specified criteria. (#133)
• Adds floating and direction fields to /api/v1/firewall/rule to support floating rules. (#188)
• Adds /api/v1/system/package endpoint to read installed packages, install new packages, or remove existing packages.
• Adds support for PUT requests to /api/v1/system/certificate to update certificates (#210)
• Adds /api/v1/system/crl endpoint to create, read and delete certificate revocation lists. (#191)
• Adds service field to /api/v1/services to restart a single service by name. (#209)
• Adds /api/v1/user/group endpoint to manage groups.

Changes

• Implements basic authentication for Local Database auth type. (#174)
• Moves /api/v1/user/group endpoint to /api/v1/user/group/member. This may be a breaking change for existing integrations!
• Converts documentation from Postman collection to OpenAPIv3. (#179)
• Embedded API documentation migrated to Swagger. Endpoint documentation is no longer available within the README.md, refer to the Swagger documentation within the pfSense webConfigurator going forward.
• Changes /api/v1/services/unbound/host_override to allow the ip field to be passed in as an array of multiple IP addresses to resolve in the DNS entry. (#105)

Full Changelog: v1.3.5...v1.4.0

pfSense API v1.3.5

Changes

• Addresses issue that prevented the gateway field from being reverted to it's default value on /api/v1/firewall/rule. (#202)
• Upgrades the php-jwt dependency to v.6.0.0.

Full Changelog: v1.3.4...v1.3.5

pfSense API v1.3.4

Adds

• Full support for pfSense 2.6.0-RELEASE.
• Minor documentation enhancements.

Changes

• Interface creations and updates on /api/v1/interface now allow the default spoofmac value. (#195)

Fixes

• Addresses bug that prevented email notification data from being read using /api/v1/system/notifications/email. (#196)
• Addresses issue that threw array errors due to the ntpd configuration now being defaulted as empty string on pfSense 2.6 instead of null like previous releases.

Full Changelog: v1.3.3...v1.3.4

pfSense API v1.3.3

Adds

• Adds staticarp field to /api/v1/services/dhcpd and adds notes regarding issues with static ARP via API. (#129)

Fixes

• Addresses issue within /api/v1/services/dhcpd that prevented DHCP server configurations from being updated when the default interface DHCP configuration was not initialized. (#178)
• Minor documentation typos.

Full Changelog: v1.3.2...v1.3.3

pfSense API v1.3.2

Fixes

• Addresses bug that caused imported CA certificates to be Base64 encoded twice before saving to configuration (#165)
• Addresses bug that sometimes caused the API UI page to hang indefinitely when no internet access was present
• Relaxes input validation on the cert field for the /api/v1/user endpoint that prevented assigning users 'server' type certificates (#165)

Changes

• 'Report an Issue' UI button now redirects to the issue type selection screen instead of a blank issue creation form

Full change log: v1.3.1...v1.3.2

pfSense API v1.3.1

New

• Adds ability to create and update dynamic gateways via /api/v1/routing/gateway endpoint. (#157)

Changes

• Updates /api/v1/interface and /api/v1/interface/apply to only apply interface configurations that have changed, greatly improving reliability and efficiency of the endpoint. (#162)
• Updates /api/v1/firewall/alias and /api/v1/firewall/alias/entry endpoints to allow clients to bypass automatic filter reloads after calls using the apply field.

Fixes

• Addresses bug that sometimes prevented the routing system changed status from be cleared after applying changes.
• Addresses issue that prevented /api/v1/interface/apply from applying bridge configurations in a timely manner. (#162)
• Addresses bug that sometimes prevented alias-subnet field from being validated correctly on /api/v1/interface endpoint.
• Addresses bug that prevented the package menu item from be removed upon deinstallation when other packages were present. (#155)
• Addresses bug that left empty /usr/local/www/api/v1/ directory upon deinstallation.

pfSense API v1.3.0

New

• Introduces /api/v1/services/dnsmasq endpoint to read the DNS Forwarder (dnsmasq) configuration
• Introduces /api/v1/services/dnsmasq/host_override endpoint to create, read, update and delete DNS Forwarder (dnsmasq) host overrides (#109)
• Introduces /api/v1/services/dnsmasq/host_override/alias endpoint to create DNS Forwarder (dnsmasq) host override alias entries
• Introduces /api/v1/services/dnsmasq/start endpoint to start the DNS Forwarder (dnsmasq) service
• Introduces /api/v1/services/dnsmasq/stop endpoint to stop the DNS Forwarder (dnsmasq) service
• Introduces /api/v1/services/dnsmasq/restart endpoint to restart the DNS Forwarder (dnsmasq) service
• Introduces HA sync feature to API settings (#97)
• Introduces /api/v1/system/ca endpoint to manage system CA certificates (#125, #34)
• Introduces /api/v1/system/api/version endpoint to pull API version information (#151)
• Introduces Update tab to API UI page for easy updates (#151)
• Introduces /api/v1/diagnostics/command_prompt endpoint to remotely execute shell commands (#144)
• Introduces /api/v1/status/openvpn endpoint to check OpenVPN server and client statuses (#61)
• Introduces /api/v1/system/console endpoint to configure console related settings
• Introduces /api/v1/interface/bridge endpoint to configure bridged interfaces
• Introduces /api/v1/services/unbound/access_list and /api/v1/services/unbound/access_list/row endpoints to configure Unbound access lists
• Introduces /api/v1/firewall/rule/flush endpoint to delete all firewall rules for Cisco-like ACL functionality
• Introduces /api/v1/services/openvpn/csc endpoint to configure OpenVPN client specific overrides (#154)
• Introduces /api/v1/system/notifications/email to update and read the SMTP notification settings

Changes

• Moves previous /api/v1/routing/gateway endpoint to /api/v1/routing/gateway/detail to make the functionality easier to understand and use (#110)
• Updates /api/v1/routing/gateway to only return gateway objects stored in configuration (#110)
• Updates /api/v1/system/certificate to allow creation of internal server and user certificates (#34)
• Updates /api/v1/user to allow assignment of user certificates to users (#34)
• Updates /api/v1/system/config to allow PUT requests that update the entire pfSense configuration

Fixes

• Addresses bug that prevented zero value system tunables from being set
• Addresses bug that prevented DHCP Server from being updated when pfSense was setup with a WAN interface only
• Addresses bug that allowed non-numeric rule tracker IDs to be successfully validated during DELETE requests to /api/v1/firewall/rule

Removes

• Removes support for pfSense 2.4 (v1.3.0 can still be forced to install on pfSense 2.4, however specific conditions that previously allowed 2.4 to operate normally have been removed. This release was not tested on 2.4 and going forward will no longer receive support. Use of v1.3.0+ on pfSense 2.4 is at your own risk

Notes

Many thanks for all the patience, support and contributions towards this release!

pfSense API v1.2.4

Fixes

• Removes validation that prevented an interface's IP from being included in the DHCP pool (#149)
• Fixes bug that prevented field descriptions from being generated in documentation for the update alias endpoint (#145)
• Enhances /api/v1/services/dhcpd/lease endpoint and fixes issue that excluded static DHCP mappings from showing in the lease data (#147)
• Fixes bug that prevented firewall rules from being created or updated with a dnpipe and pdnpipe of the same type (#132)

pfSense API v1.2.3

New

• Adds full support for pfSense 2.5.1-RELEASE and 2.5.2-RELEASE

Fixes

• Addresses interface track IPv6 prefix bug (#138)