Skip to content

pfSense REST API v2.2.0

Choose a tag to compare

View all tags
@jaredhendrickson13 jaredhendrickson13 released this 05 Oct 03:03
· 515 commits to master since this release
v2.2.0
8668101
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

New Features

  • Introduced a new GraphQL API at /api/v2/graphql.
  • Added /api/v2/services/bind* endpoints for managing the BIND DNS server package (#276).
  • Added /api/v2/system/certificate/pkcs12/export endpoint to export certificates as PKCS#12 archives (#470).
  • Added /api/v2/system/certificate/renew endpoint to renew internal certificates.
  • Added /api/v2/system/crl/revoked_certificate endpoint to manage revoked certificates via CRL (#166).
  • Added /api/v2/system/certificate_authority/generate endpoint to create new internal Certificate Authorities (CA) (#519).
  • Added /api/v2/system/certificate/generate endpoint to create new internal certificates.
  • Added /api/v2/system/certificate/signing_request endpoint to create new Certificate Signing Requests (CSR) (#250).
  • Added /api/v2/system/certificate/signing_request/sign endpoint to sign existing CSRs (#250).
  • Added support for deleting DHCP leases via /api/v2/status/dhcp_server/leases (#130).
  • Added /api/v2/status/logs/settings endpoint for reading and updating log settings.
  • Added /api/v2/status/ipsec/sa endpoints to retrieve IPsec tunnel statuses (#571).
  • Added /api/v2/status/ipsec/child_sa endpoint to retrieve specific IPsec child SA status (#571).
  • Added new sort_by and sort_order parameters to control object sorting in config or before writing to the pfSense configuration (#565).
  • Introduced a new expose_sensitive_fields setting to allow exposure of sensitive fields in API responses.

Changes

  • Updated the OpenVPNServer tls field to automatically generate a TLS key if one is not provided (#570).
  • OpenVPNServer tls* fields are now only available when use_tls is set to true (#570).
  • Replaced the pfsense-restapi generatedocs command with pfsense-restapi buildschemas.
  • Marked the OpenVPN tls field as 'sensitive,' so it will no longer appear in API responses by default.

Bug Fixes

  • Fixed an issue where large REST API configurations could interfere with the API sync feature.
  • Fixed a bug where the REST API's config lock timeout failed to generate the expected error.
  • Fixed an issue where the WireGuardPeer presharedkey field could not be empty. #581

Full Changelog: v2.1.3...v2.2.0

Assets 4
Loading