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
🔗
APIsJSON
https://raw.githubusercontent.com/api-evangelist/opnsense/refs/heads/main/apis.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/core-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

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