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
image: https://kinlane-productions.s3.amazonaws.com/apis-json/apis-json-logo.jpg
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
common:
  - type: Website
    url: https://opnsense.org
  - type: Documentation
    url: https://docs.opnsense.org
  - type: Download
    url: https://opnsense.org/download/
  - type: Forum
    url: https://forum.opnsense.org
  - type: GitHub Organization
    url: https://github.com/opnsense
  - type: Business Edition
    url: https://shop.opnsense.com
maintainers:
  - FN: Kin Lane
    email: kin@apievangelist.com