OPNsense

OPNsense Diagnostics API

Interface and system diagnostics.

Documentation GitHub OpenAPI

Specifications

⚙

OpenAPI

https://raw.githubusercontent.com/api-evangelist/opnsense/refs/heads/main/openapi/opnsense-diagnostics-api-openapi.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/opnsense-diagnostics-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.

OpenAPI Specification

openapi: 3.1.0
info:
  title: OPNsense REST Core Diagnostics API
  description: 'REST API for OPNsense, an open source FreeBSD-based firewall and routing platform.

    The API follows a uniform URL pattern:

    `/api/<module>/<controller>/<command>/[<param1>/<param2>/...]`

    and uses HTTP Basic Authentication where the API key is supplied as the

    username and the API secret as the password.


    Only GET and POST verbs are used: GET retrieves data, POST creates,

    updates, or executes actions.

    '
  version: 1.0.0
  contact:
    name: OPNsense
    url: https://opnsense.org
  license:
    name: BSD 2-Clause
    url: https://opensource.org/licenses/BSD-2-Clause
servers:
- url: https://{host}/api
  description: OPNsense host API base path
  variables:
    host:
      default: opnsense.local
      description: Hostname or IP of the OPNsense firewall
security:
- basicAuth: []
tags:
- name: Diagnostics
  description: Interface and system diagnostics.
paths:
  /diagnostics/interface/getInterfaceNames:
    get:
      tags:
      - Diagnostics
      summary: List interface names
      description: Returns the list of available network interface names.
      operationId: getInterfaceNames
      responses:
        '200':
          description: Map of interface device names.
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: string
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  responses:
    Unauthorized:
      description: Authentication failed or missing.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  schemas:
    ErrorResponse:
      type: object
      properties:
        status:
          type: string
        message:
          type: string
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: 'HTTP Basic Authentication with the API key as username and the

        API secret as password.

        '
externalDocs:
  description: OPNsense API Documentation
  url: https://docs.opnsense.org/development/api.html