OPNsense Core API

openapi: 3.1.0
info:
  title: OPNsense REST Core 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: Core
  description: Core OPNsense service controllers.
paths:
  /core/service/search:
    post:
      tags:
      - Core
      summary: Search services
      description: Search the list of OPNsense services with grid parameters.
      operationId: searchCoreServices
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GridSearchRequest'
      responses:
        '200':
          description: Search result set.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GridSearchResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /core/firmware/status:
    get:
      tags:
      - Core
      summary: Get firmware status
      description: Returns the current firmware status of the system.
      operationId: getFirmwareStatus
      responses:
        '200':
          description: Firmware status payload.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
        '401':
          $ref: '#/components/responses/Unauthorized'
  /core/system/status:
    get:
      tags:
      - Core
      summary: Get system status
      description: Returns overall system status information.
      operationId: getSystemStatus
      responses:
        '200':
          description: System status payload.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    GridSearchRequest:
      type: object
      properties:
        current:
          type: integer
          description: Current page number (1-based).
          default: 1
        rowCount:
          type: integer
          description: Rows per page.
          default: 20
        sort:
          type: object
          additionalProperties:
            type: string
        searchPhrase:
          type: string
    GridSearchResponse:
      type: object
      properties:
        total:
          type: integer
        rowCount:
          type: integer
        current:
          type: integer
        rows:
          type: array
          items:
            type: object
            additionalProperties: true
    ErrorResponse:
      type: object
      properties:
        status:
          type: string
        message:
          type: string
  responses:
    Unauthorized:
      description: Authentication failed or missing.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  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