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.

GitHub

Documentation

📖
Documentation
https://docs.opnsense.org/development/api.html
📖
Authentication
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

API entry from apis.yml

apis.yml Raw ↑ 
aid: opnsense:core-api
name: OPNsense Core REST API
description: 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.
humanURL: https://docs.opnsense.org/development/api.html
baseURL: https://opnsense.local/api
tags:
- Firewall
- Networking
- VPN
- System Administration
properties:
- type: Documentation
  url: https://docs.opnsense.org/development/api.html
- type: Core API Reference
  url: https://docs.opnsense.org/development/api.html#core-api
- type: Plugins API Reference
  url: https://docs.opnsense.org/development/api.html#plugins
- type: Authentication
  url: https://docs.opnsense.org/development/how-tos/api.html