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

pfSense API v1.1.4

Fixes

• Bug that prevented exact matches from returning in recursive API queries
• Bug that re-initialized the NAT configuration when creating an initial port forward from the API after another NAT setting had already initialized the NAT configuration
• Bug that overwrote the source and destination ports when updating port forwards
• Bug that threw an unexpected error when manually specifying a VHID after creating/updating a CARP virtual IP

Changed

• Successive firewall rule creations are now delayed by one second to prevent rules from obtaining the same tracker ID value

pfSense API v1.1.3

Adds

• Ability to create/update firewall rules with a gateway group in the gateway field
• age, expires_in, packets_total, packets_in, packets_out, bytes_total, bytes_in, and bytes_out fields to returned firewall states

Fixes

• Bug that incorrectly parsed firewall states for some interface types
• Bug that prevented clients from updating the log field on firewall rules
• Bug that allowed clients to create/update gateway objects that use an existing gateway group name

pfSense API v1.1.2

Adds

• Improved performance and validation for the /api/v1/firewall/alias endpoint
• Support for port aliases for the /api/v1/firewall/rule endpoint

Fixes

• Bug that allowed disabled users to authenticate using existing API tokens when utilizing the API Token authentication mode
• Bug that re-initialized the NAT configuration when adding new one-to-one NAT mappings

pfSense API v1.0.4

Fixes

• Bug that allowed disabled users to authenticate using existing API tokens when utilizing the API Token authentication mode

pfSense API v1.1.1

Added

• Rotate server key button on UI page when utilizing API Token authentication mode
• rotateserverkey CLI command on pfsense-api executable to rotate the server key via command line

Changes

• Rotating server key will now revoke existing API tokens automatically

Fixes

• Report an Issue button on UI page now functions as expected

pfSense API v1.1.0

Please double check your scripts against the developer documentation before implementing this release in a production environment.

Added

• Content-Type header support
• API Token authentication via authentication header
• Gateway status endpoint to read gateway metrics (e.g. packet loss, latency)
• Interface status endpoint to read interface metrics (e.g. packets in, packets out, collisions, errors)
• System status endpoint to read system metrics (e.g. CPU, RAM, Disk usage)
• Update functionality to interface endpoint
• Apply interface endpoint to apply pending interface configuration
• Creation, update and deletion functionality to gateway endpoint
• Update function to port forwards endpoint
• Adds endpoint for creating, updating, reading, and deleting outbound NAT entries
• Adds endpoint for creating, updating, reading, and deleting 1:1 NAT entries
• Adds endpoint for reading DDNS configuration and status
• Adds endpoint for reading DHCP Leases
• Adds report an issue links to API configuration page and API documentation page
• Back to pfSense button added to API Docuementation
• Persistent API configuration that will survive package updates
• Adds pfsense-api command line tool

Changes

• Interface endpoint does not apply new configuration by default, this allows clients to create/update multiple interface configurations quickly and apply them all at once.
• Changes routing endpoints to not apply new configurations by default, this allows clients to create/update multiple routing object configurations quickly and apply them all at once
• Changes firewall endpoints to not apply new configurations by default, this allows clients to create/update multiple firewall object configurations quickly and apply them all at once

Fixes

• Bug that prevented unbound host overrides from being updated with the same values
• Various minor interface bugs