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)

pfSense API v1.2.2

Adds

• Ability to create and update virtual IPs using CARP interfaces on /api/v1/firewall/virtual_ip (#117)

Fixes

• Invalid permission name for some actions on /api/v1/firewall/alias (#122)
• Minor UI corrections

pfSense API v1.2.1

Adds

• Ability to use existing aliases as address entries within another alias (#112)

Fixes

• Bug that prevented descriptions from being set within Unbound host override aliases (#111)
• Bug that sometimes caused gateway object IDs to fall out of sync with the XML configuration (#110)

pfSense API v1.2.0

Adds

• Adds /api/v1/system/halt endpoint to shutdown pfSense
• Adds /api/v1/system/reboot endpoint to reboot pfSense
• Adds /api/v1/firewall/traffic_shaper endpoint to interact with interface traffic shapers
• Adds /api/v1/firewall/traffic_shaper/queue endpoint to interact with interface traffic shaper queues
• Adds /api/v1/firewall/traffic_shaper/limiter endpoint to interact with limiters
• Adds /api/v1/firewall/traffic_shaper/limiter/bandwidth endpoint to interact with limiter bandwidth settings
• Adds /api/v1/firewall/traffic_shaper/limiter/queue endpoint to interact with limiter queues
• Adds /api/v1/firewall/schedule endpoint to interact with firewall schedules
• Adds /api/v1/firewall/schedule/time_range endpoint to interact with schedule time ranges
• Adds ability to specify firewalls schedule and shapers in firewall rules on /api/v1/firewall/rule endpoint
• Adds support for PUT requests on /api/v1/system/api to update the API configuration
• Adds endpoint for /api/v1/services/ntpd to read and update the NTP configuration
• Adds endpoint for /api/v1/services/ntpd/time_server to add or remove NTP timeservers
• Adds ability to allow OPTIONS requests
• Adds ability to set custom response headers in API resposnes

Changes

• Optimizes /api/v1/firewall/states/size endpoint
• Overhauls the API settings page with a simpler, more organized design
• Interface virtual IPs are now included when specifying allowed interfaces

NOTE: Due to issues with the packaging system, v1.2.x will be the last version supporting pfSense 2.4 (excluding patches).

pfSense API v1.1.7

Adds

• Adds additional validation to the username, expires and ipsecpsk fields on /api/v1/user
• Adds ability to create and update users with privileges on /api/v1/user
• Adds ability to set non-default pfSense privileges on /api/v1/user/privilege and /api/v1/user

Fixes

• Fixes update path for pfSense 2.5 within the pfsense-api command line tool
• Fixes bug that prevented passwords from being saved upon creation on /api/v1/user (#99)
• Fixes bug that sometimes allowed clients to delete system users on /api/v1/user
• Fixes unique constraint for vhid on /api/v1/firewall/virtual_ip to be unique per interface (#100)

pfSense API v1.1.6

Adds

• Adds the ability to create port forwards with port aliases in the srcport, dstport and local-port fields

Fixes

• Fixes bug that allowed duplicate DNS servers to be added on /api/v1/system/dns/server
• Fixes bug that incorrectly set the dnslocalhost value for pfSense 2.5+ on /api/v1/system/dns
• Fixes bug that caused blank DNS server entries on /api/v1/system/dns/server
• Fixes bug that prevented the /api/v1/system/hostname endpoint from correctly applying backend changes

pfSense API v1.1.5

Adds

• Ability to add Unbound host override with IPv4 and IPv6 address
• Improved validation for /api/v1/unbound/host_override
• Ability to add firewall rule with destination (self)

Fixes

• Bad file override for pfSense 2.5.0 that caused error on ARP Table UI page
• Missing/changed interface functions on pfSense 2.5.0
• Bug that sometimes prevented port forward port values from being updated
• PHP warning when rotating API server key on pfSense 2.5.0