# OPNsense Core REST API

**Canonical:** https://apis.io/apis/opnsense/core-api/  
**Provider:** OPNsense — https://apis.io/providers/opnsense/  
**Base URL:** https://opnsense.local/api  
**Documentation:** https://docs.opnsense.org/development/api.html

OPNsense Core REST API is one of 4 APIs that [OPNsense](https://apis.io/providers/opnsense/) publishes on the [APIs.io](https://apis.io/) network. Tagged areas include Firewall, Networking, VPN, and System Administration. The published artifact set on APIs.io includes API documentation and authentication docs.

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.

## Machine-readable artifacts (5)

- **Documentation** — https://docs.opnsense.org/development/api.html
- **Core API Reference** — https://docs.opnsense.org/development/api.html#core-api
- **Plugins API Reference** — https://docs.opnsense.org/development/api.html#plugins
- **Authentication** — https://docs.opnsense.org/development/how-tos/api.html
- **APIsJSON** — https://raw.githubusercontent.com/api-evangelist/opnsense/refs/heads/main/apis.yml

## Other OPNsense APIs (3)

- [OPNsense Core API](https://apis.io/apis/opnsense/opnsense-core-api/)
- [OPNsense Diagnostics API](https://apis.io/apis/opnsense/opnsense-diagnostics-api/)
- [OPNsense Firewall API](https://apis.io/apis/opnsense/opnsense-firewall-api/)

## Tags

Firewall, Networking, VPN, System Administration

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/opnsense/core-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/opnsense/.