aiopnsense

aiopnsense is an asynchronous Python client library for OPNsense.

Contents

• Installation
• Requirements
• Quickstart
  • Minimal client setup
  • Explicit validation
• Authentication
  • Connection model
  • TLS verification
• API Reference
  • Main Client
  • Firmware
  • System
  • Telemetry
  • DHCP and ARP
  • Firewall and NAT
  • Services
  • Unbound
  • VPN
  • vnStat
  • Speedtest
  • Vouchers
  • Exceptions
• Examples
  • Read system state and telemetry
  • Check firmware or control a service
• Changelog
  • v1.0.10 (2026-05-29)
  • v1.0.9 (2026-05-29)
  • v1.0.8 (2026-04-06)
  • v1.0.7 (2026-04-05)
  • v1.0.6 (2026-04-05)
  • v1.0.5 (2026-04-03)
  • v1.0.4 (2026-03-29)
  • v1.0.3 (2026-03-26)
  • v1.0.2 (2026-03-23)
  • v1.0.1 (2026-03-23)
  • v1.0.0 (2026-03-22)
  • v0.0.3 (2026-03-22)
  • v0.0.2 (2026-03-22)
  • v0.0.1 (2026-03-22)
• External References
  • OPNsense API references
• Development