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 4 API contracts indexed on the APIs.io network, including Core API, Diagnostics API, Firewall API, and 1 more. Tagged areas include Firewall, Networking, Security, VPN, and Routing.

The OPNsense catalog on APIs.io includes 1 Spectral governance ruleset.

OPNsense’s developer surface includes engineering blog, authentication, documentation, and 9 more developer resources.

🌐 Visit website 📡 Profile data on GitHub

25.2/100 emerging ▬ flat Agent 19/100 agent aware Front door AI 1/6 silent Heartbeat 100/100 alive Full breakdown ↓
scored 2026-11-06 · rubric v0.27.0 · Show this score on your site →

1 published contract

Firewall Networking Security VPN Routing Open Source

What this lets a business do 2

Business capabilities this provider's published APIs can perform, derived from its own contracts. Browse all capabilities →

Information Technology Management

BC-600

Core

POST /core/service/search GET /core/firmware/status GET /core/system/status

Cybersecurity Management

BC-620

Firewall

GET /firewall/alias/get POST /firewall/alias/reconfigure

Kin Score

Kin Score How this is scored →
scored 2026-11-06 · rubric v0.27.0

Composite quality — 25.2/100 · emerging

Contract Quality 9.1 / 19

Developer Ergonomics 4.3 / 15

Access Clarity 0.0 / 15

Operational Transparency 0.3 / 10

Contract Governance 1.2 / 9

Discoverability 5.0 / 8

Regulatory Posture 1.8 / 15

Create-or-Update Ergonomics 0.0 / 10

Agent readiness — 19/100 · agent aware

Machine-Readable Contract 18 / 18

Agentic Access Contract 10 / 10

Documented Reversibility 0 / 6

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

Delegated User Identity 0 / 6

Protected Resource Metadata 0 / 5

Registration Without a Human 0 / 6

Agentic Commerce Well-Known Document 0 / 5

Pagination 5 / 5

Distinct Operations 3 / 3

MCP Tool Quality 6 / 6

Regulatory Posture applies to this provider. Its tags matched the Horizontal (data, software, accessibility, platform) regime, so Regulatory Posture carries 15 points of the composite. If this regime is wrong for your business, say so on your provider repo — the applicability map is public and we will correct it.

Create-or-Update Ergonomics applies to this provider. This API accepts writes, so it carries 10 points of the composite. It is scored from the published contracts themselves: whether a caller can create-or-update in one call, whether the write accepts a key the caller already holds, and whether the response says which branch ran. Without that, every write needs a search-and-branch in front of it, and the first time that check is skipped a duplicate record is created. Scored against the observed mean rather than raw — a provider at the catalog average is unchanged by this facet, not penalised by it.

The six quality facets above are damped to 75 points between them, because the conditional facet above carries the other 25. That is why each facet's contribution is shown against a damped maximum: raising a quality facet moves the composite by 75% of its nominal weight, not 100%. The full arithmetic is at apis.io/rating/.

Show this score on your site.

It updates itself when the score changes. Paste this where you link to your API docs:

<a href="https://apis.io/providers/opnsense/"><img src="https://apis.io/badge/opnsense/card.svg" alt="OPNsense on APIs.io — Kin Score by API Evangelist"></a>

Other styles, a README pill and a shields.io endpoint are on the badge page.

Raise your score.

Agent readiness — checks not met, largest first (exact, from this profile):

MCP Server +12 pts — deployment.mode + probe verdict on the mcp/ manifest, not the pointer; an unprobed slug falls back to authorship
Idempotency +9 pts — OpenAPI mutating operations declare an idempotency key — a header, a request-body property, or a named de-duplication token whose own description says so (verified); else common[].type matches /idempoten/i (documented)
Stable Error Semantics +8 pts — OpenAPI $refs a shared error schema across 4xx/5xx responses (verified), else common[].type includes ErrorCatalog / ErrorCodes / DeclineCodes
A2A Agent Card +8 pts — a2a/-a2a.yml manifest, graded on conformance.grade against A2A 1.0.0
Rate-Limit Signaling +7 pts — OpenAPI responses document X-RateLimit-* / RateLimit headers (verified), else a rate_limits artifact or RateLimits link (documented)
Request/Response Examples +7 pts — share of operations carrying request/response examples; else an Examples / Code Samples link

10 more unmet checks in the Agent Readiness table above.

Kin Score — facets with the most composite points still available (weight × headroom):

Access Clarity scores 0.0 — up to +20.0 composite points
Developer Ergonomics scores 28.6 — up to +14.3 composite points
Contract Quality scores 48.4 — up to +12.9 composite points

Each check links to what satisfies it. Publish the artifact, or tell us where it already lives, and the score moves on the next scoring run.

Improve this rating by publishing the missing artifacts — every area above can be raised, and the full rubric is at apis.io/rating/. Every facet and dimension name above is a link: it opens that measurement's own page — what it means, the exact checks that feed it, how the whole catalog distributes on it, and the providers at the top of it. This rating is computed from the provider profile at artifacts.apis.io/opnsense/apis.yml: open an issue on github.com/api-evangelist/opnsense to ask a question or point us at an artifact you publish. Submit an artifact on GitHub — free → Manage your own listing — the Influence plan, $499/mo →

Standards implemented 2

Standards this provider implements or carries. De facto ones are profiled and measured by the API Commons; formal ones come from the standards directory and are linked by the provider's own tags. The evidence column says how each claim was established — not that it was made.

VPN

tagged — the provider's own APIs.json carries the standard as a tag; implementation not verified

OpenAPI

measured — observed by APIs.io (published)

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 4

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

OPNsense REST Core API

OPEN COLLECTION

OPNsense REST Core Diagnostics API

OPEN COLLECTION

OPNsense REST Core Firewall API

OPEN COLLECTION

OPNsense Core REST API

OPEN COLLECTION

Spectral Rules 1

Spectral governance rulesets for linting and validating these APIs.

OPNsense API Rules

58 rules · 56 errors 1 warnings 1 info

SPECTRAL

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 · 1 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 3

The organization behind the API

Blog

Blog

LinkedIn

Website

Website

Other 3

Properties that don't map to a standard resource type

CapabilityMap

CapabilityMap

Download

Download

Business Edition

Business Edition

Source (apis.yml)

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
deliveryModel:
  model: unknown
  open_source: false
  commercial: false
  callable_host: false
  label: Delivery model not determined — needs a product licence on record
  confidence: low
  source:
  - openapi
  generated: '2026-08-28'
  method: derived
accessModel:
  pricing: unknown
  onboarding: unknown
  trial: false
  try_now: false
  public: false
  label: Unknown
  confidence: low
  source:
  - authentication
  - security
  generated: '2026-11-06'
  method: derived
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/icons/opnsense.png
x-docs-platform: sphinx
x-docs-platform-confidence: medium
x-docs-platform-checked: 2026-10-04
tags:
- Firewall
- Networking
- Security
- VPN
- Routing
- Open Source
tags_raw:
- Firewall
- Networking
- Security
- VPN
- Routing
- Open Source
- Open-Source
url: https://raw.githubusercontent.com/api-evangelist/opnsense/refs/heads/main/apis.yml
created: '2026-05-11'
modified: '2026-10-06'
specificationVersion: '0.23'
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:
- url: https://opnsense.org/blog/
  type: Blog
- type: CapabilityMap
  url: capabilities/opnsense-capability-edges.yml
  name: OPNsense Business Capability Map
- 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

OPNsense API — frequently asked questions

Does OPNsense have an API?

Yes. APIs.io lists 4 APIs from OPNsense, including OPNsense Core REST API, OPNsense Core API and OPNsense Diagnostics API, and 1 more.

Is there an OpenAPI specification for the OPNsense API?

Yes. APIs.io indexes 3 OpenAPI specifications for OPNsense, each linked for download from this page.

How do I authenticate with the OPNsense API?

OPNsense uses bearer-token authentication (http · 1 scheme). The details are profiled on APIs.io as Opnsense Authentication.

Is the OPNsense API ready for AI agents?

OPNsense has a Kin Score of 25.2 out of 100 (emerging) and an Agent Readiness score of 19.0 (agent-aware), scored by API Evangelist on 2026-11-06.

Work with this as data

Every provider 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 providers

9 MCP tools reach this

find_providersBrowse and filter every provider in the catalog.
get_provider_artifactsEvery artifact this provider publishes, grouped by type.
get_provider_operationsEvery operation across all of their OpenAPIs — one call instead of parsing every spec.
get_provider_toolsEvery MCP tool they ship, with the operation each wraps.
get_provider_evidenceHow each part of their score was established. Free — the basis for a claim should not sit behind it.
get_provider_ratingPRO — composite, band, trend and facet scores.
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 provider

curl "https://apis.io/api/v1/providers/opnsense"

All providers

curl "https://apis.io/api/v1/providers?limit=25"

Every operation they expose

curl "https://apis.io/api/v1/providers/opnsense/operations?limit=25"

How their score was established

curl "https://apis.io/api/v1/providers/opnsense/evidence"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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