OPNsense website screenshot

OPNsense

OPNsense is an open source FreeBSD-based firewall and routing platform providing stateful packet filtering, VPN (IPsec, OpenVPN, WireGuard), intrusion detection (Suricata), traffic shaping, captive portal, and high availability for home, enterprise, and managed service provider deployments. The platform features a web UI, plugin ecosystem, and a comprehensive Business Edition. OPNsense exposes a REST API for managing every core module and plugin, using HTTP basic authentication with an API key and secret.

OPNsense publishes 3 APIs on the APIs.io network: Core API, Diagnostics API, and Firewall API. Tagged areas include Firewall, Networking, Security, VPN, and Routing.

OPNsense’s developer surface includes authentication, documentation, and 8 more developer resources.

🌐 Visit website 📡 Source on GitHub
26.4/100 emerging ▬ flat Agent 28/100 agent aware Full breakdown ↓
scored 2026-07-28 · rubric v0.6
AccessSelf serve
4 APIs
FirewallNetworkingSecurityVPNRoutingOpen Source

Kin Score

Kin Score Kin Score How this is scored →
scored 2026-07-28 · rubric v0.6
Composite quality — 26.4/100 · emerging
Contract Quality 14.4 / 25
Developer Ergonomics 3.9 / 20
Commercial Clarity 0.0 / 20
Operational Transparency 0.7 / 13
Governance 0.0 / 12
Discoverability 7.4 / 10
Agent readiness — 28/100 · agent aware
Machine-Readable Contract 18 / 18
Agentic Access Contract 10 / 10
MCP Server 0 / 12
Machine-Readable Auth 10 / 10
Idempotency 0 / 9
Stable Error Semantics 0 / 8
Request/Response Examples 0 / 7
Rate-Limit Signaling 0 / 7
Typed Event Surface 0 / 6
Agent Skills 0 / 5
Well-Known Catalog 0 / 4
Consent & Bot Identity 0 / 3
A2A Agent Card 0 / 8
Dry-Run / Simulate Mode 0 / 4
Improve this rating by publishing the missing artifacts — every area above can be raised, and the full rubric is at apis.io/rating/. This rating is computed from github.com/api-evangelist/opnsense: open an issue to ask a question, or submit a pull request to add artifacts. Want it done for you? Prioritized profiling — $2,500 →

APIs 4

Individual APIs this provider publishes, each with its own machine-readable definition.

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. Authentic...

OPNsense Core API

Core OPNsense service controllers.

OPNsense Diagnostics API

Interface and system diagnostics.

OPNsense Firewall API

Firewall filter and aliases.

Open Collections 1

Open, tool-agnostic API collections (OpenAPI-derived and Bruno).

OPNsense Core REST API

OPEN COLLECTION

Security Posture 2

Authentication, domain security, vulnerability disclosure, and trust-center signals.

Opnsense Authentication

http · 1 scheme

SECURITY

Opnsense Domain Security

TLSv1.3 · HSTS · DNSSEC · DMARC

SECURITY

Agentic Access 1

Recommended x-agentic-access execution contracts for AI agents.

Opnsense Agentic Access

6 operations · 2 acting

6 operations · 2 acting

AGENTIC

Resources

Documentation 1

Reference material describing how the API behaves

Documentation
Documentation

Agent Surfaces 1

MCP servers, agent skills, and machine-readable catalogs

AgenticAccess
AgenticAccess

Build 1

SDKs, sample code, and the tooling you integrate with

GitHubOrganization
GitHubOrganization

Access & Security 2

Authentication, authorization, and security posture

DomainSecurity
DomainSecurity
 Authentication
Authentication

Operate 1

Status, limits, changes, and where to get help

Forums
Forums

Company 2

The organization behind the API

LinkedIn
LinkedIn
 Website
Website

Other 2

Properties that don't map to a standard resource type

Download
Download
 Business Edition
Business Edition

Source (apis.yml)

apis.yml Raw ↑ 
aid: opnsense
name: OPNsense
description: OPNsense is an open source FreeBSD-based firewall and routing platform providing stateful packet filtering, VPN
  (IPsec, OpenVPN, WireGuard), intrusion detection (Suricata), traffic shaping, captive portal, and high availability for
  home, enterprise, and managed service provider deployments. The platform features a web UI, plugin ecosystem, and a comprehensive
  Business Edition. OPNsense exposes a REST API for managing every core module and plugin, using HTTP basic authentication
  with an API key and secret.
type: Index
accessModel:
  pricing: unknown
  onboarding: self-serve
  trial: false
  try_now: false
  public: false
  label: Self-serve signup
  confidence: medium
  source:
  - authentication
  generated: '2026-07-22'
  method: derived
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/icons/opnsense.png
tags:
- Firewall
- Networking
- Security
- VPN
- Routing
- Open Source
url: https://raw.githubusercontent.com/api-evangelist/opnsense/refs/heads/main/apis.yml
created: '2026-05-11'
modified: '2026-05-11'
specificationVersion: '0.19'
apis:
- 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
- aid: opnsense:opnsense-core-api
  name: OPNsense Core API
  description: Core OPNsense service controllers.
  humanURL: https://docs.opnsense.org/development/api.html
  baseURL: https://opnsense.local/api
  tags:
  - Core
  properties:
  - type: OpenAPI
    url: openapi/opnsense-core-api-openapi.yml
- aid: opnsense:opnsense-diagnostics-api
  name: OPNsense Diagnostics API
  description: Interface and system diagnostics.
  humanURL: https://docs.opnsense.org/development/api.html
  baseURL: https://opnsense.local/api
  tags:
  - Diagnostics
  properties:
  - type: OpenAPI
    url: openapi/opnsense-diagnostics-api-openapi.yml
- aid: opnsense:opnsense-firewall-api
  name: OPNsense Firewall API
  description: Firewall filter and aliases.
  humanURL: https://docs.opnsense.org/development/api.html
  baseURL: https://opnsense.local/api
  tags:
  - Firewall
  properties:
  - type: OpenAPI
    url: openapi/opnsense-firewall-api-openapi.yml
common:
- type: AgenticAccess
  url: agentic-access/opnsense-agentic-access.yml
- type: DomainSecurity
  url: security/opnsense-domain-security.yml
- type: Authentication
  url: authentication/opnsense-authentication.yml
- type: LinkedIn
  url: https://www.linkedin.com/showcase/opnsense
- type: Website
  url: https://opnsense.org
- type: Documentation
  url: https://docs.opnsense.org
- type: Download
  url: https://opnsense.org/download/
- type: Forums
  url: https://forum.opnsense.org
- type: GitHubOrganization
  url: https://github.com/opnsense
- type: Business Edition
  url: https://shop.opnsense.com
maintainers:
- FN: Kin Lane
  email: kin@apievangelist.com