OPNsense

OPNsense Core REST API

REST API covering all core OPNsense modules including firewall, NAT, interfaces, VPN (IPsec, OpenVPN, WireGuard), routing, DHCP, DNS, users, and system administration. Authentication uses HTTP basic auth with an API key as username and API secret as password.

Documentation GitHub

Documentation

https://docs.opnsense.org/development/api.html

https://docs.opnsense.org/development/how-tos/api.html

Other Resources

Core API Reference

https://docs.opnsense.org/development/api.html#core-api

Plugins API Reference

https://docs.opnsense.org/development/api.html#plugins

https://raw.githubusercontent.com/api-evangelist/opnsense/refs/heads/main/apis.yml

OpenAPI Specification