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

pfSense API v1.0.3

Changed

• Fixes bug that unexpectedly reverted existing VLANs when creating new VLAN interfaces
• Fixes bug that periodically prevented interface reassignment
• Fixes bug that incorrectly identified interfaces as LAGG interfaces
• Minor framework adjustments

pfSense API v1.0.2

Changed

• Minor framework adjustments
• Fixes bug that added empty alias entries when utilizing the /api/v1/firewall/alias/entry endpoint

pfSense API v1.0.1

pfSense API v1.0.1

Changed

• Fixes bug that unnecessarily required the protocol field when updating firewall rules
• Fixes bug that prevented ports from behaving correctly when updating firewall rules
• Fixes bug that prevented firewall rules from being disabled
• Fixes bug that prevents clients from receiving access tokens when API is set to read only mode
• Fixes bug that would sometimes prevent the API server key from being generated correctly
• Fixes bug that sometimes allowed embedded API docs to be viewed without privilege
• Download URL has changed to better support updates

pfSense API v1.0.0

pfSense API v1.0.0

Initial production ready release. Some key changes from beta releases are:

Added

• Documentation tool embedded within API page of pfSense webConfigurator
• System tunable API endpoints
• System table API endpoints
• Static route API endpoints
• Status log API endpoints
• DHCP configuration API endpoints
• DHCP static mapping API endpoints
• API query engine

Changed

• PUT and DELETE requests are now supported
• API framework improvements to improve speed and security
• Endpoint URLs have changed to reflect a more traditional REST style
• Endpoint URLs no longer require trailing slash
• Parameters have been simplified to better match pfSense's XML configuration
• Improved validation

pfSense API (Beta) v0.0.3

New:

• Adds support for JWT bearer authentication to provide a more traditional REST API
• Introduces new framework to assist development and extensions

Changes:

• Converted function based structure to object oriented structure
• Removed Base64 as authentication mode
• Removes search field from GET API calls

pfSense API (Beta) v0.0.2

• Optimized /services/unbound/ API calls
• Added ability to run /services/unbound/ API calls without immediately applying the configuration changes after each call. Users will see a big performance improvement when adding/modifying/deleting Unbound host overrides in bulk
• Added API endpoint for /services/unbound/apply/ to apply pending Unbound configuration changes
• Updated documentation

pfSense API (Beta) v0.0.1

Merge pull request #1 from jaredhendrickson13/development

v0.0.1 (Beta)