Skip to content

pfSense API v1.3.0

Choose a tag to compare

View all tags
@jaredhendrickson13 jaredhendrickson13 released this 30 Sep 05:12
· 2498 commits to master since this release
v1.3.0
d7c41c1
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Verified
Learn about vigilant mode.

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!

Assets 4
Loading