pfapi_openapi.yml

openapi: 3.0.3
info:
  title: pfSense API
  version: "1.0"
  description: This is the schema for APIs to manage pfSense devices

tags:
  - name: auth
    description: Authentication
  - name: login
    description: Authentication Operations
  - name: controller
    description: pfSense Controller operations
  - name: events
    description: Device events
  - name: system
    description: System configuration
  - name: aliases
    description: Firewall aliases
  - name: interfaces
    description: Network interfaces
paths:
  /aliases:
    get:
      tags:
        - aliases
      summary: Get firewall aliases
      description: ""
      operationId: FirewallGetAliases
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FWAliases'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      tags:
        - aliases
      summary: Create a new alias
      description: ""
      operationId: FirewallAddAlias
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FWAliasReq'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /aliases/{index}:
    parameters:
      - in: path
        name: index
        required: true
        schema:
          type: string
    get:
      tags:
        - aliases
      summary: Get a firewall alias
      description: ""
      operationId: FirewallGetAlias
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FWAlias'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    put:
      tags:
        - aliases
      summary: Update firewall alias
      description: ""
      operationId: FirewallUpdateAlias
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FWUpdateAliasreq'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    delete:
      tags:
        - aliases
      summary: Delete alias
      description: ""
      operationId: FirewallDeleteAlias
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /auth:
    get:
      tags:
        - auth
      summary: Return authentication servers
      description: ""
      operationId: GetAuthServers
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthServersList'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /auth/test:
    post:
      tags:
        - auth
      summary: ""
      description: ""
      operationId: AuthTestAuthentication
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AuthTestCredentials'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthTestResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /controller:
    get:
      tags:
        - controller
      summary: Get controller information
      description: ""
      operationId: GetControllerDescrip
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ControllerDescrip'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /controller/alarms:
    get:
      tags:
        - controller
      summary: Get summary of alarms
      description: ""
      operationId: GetControllerAlarms
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ControllerAlarms'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /controller/logs:
    get:
      tags:
        - controller
      summary: Get controller logs
      description: ""
      operationId: GetControllerLogs
      parameters:
        - in: query
          name: device_name
          schema:
            type: string
        - in: query
          name: type
          schema:
            type: string
        - in: query
          name: from_ts
          schema:
            type: integer
        - in: query
          name: to_ts
          schema:
            type: integer
        - in: query
          name: class
          schema:
            type: string
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LogEntries'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /controller/service:
    post:
      tags:
        - controller
      summary: Request action on the controller process
      description: ""
      operationId: ControllerAction
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ControllerServiceAction'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /controller/stats:
    get:
      tags:
        - controller
      summary: Get controller stats
      description: ""
      operationId: GetControllerStats
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ControllerStats'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /diag/activity:
    get:
      tags:
        - diag
      summary: Get system activity based on "top" output
      description: ""
      operationId: DiagGetActivity
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DiagActivity'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /diag/arp:
    get:
      tags:
        - diag
      summary: Get ARP table
      description: ""
      operationId: DiagGetArpTable
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DiagArpTable'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    delete:
      tags:
        - diag
      summary: Delete ARP table
      description: ""
      operationId: DiagDeleteArpTable
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /diag/arp/{ip}:
    parameters:
      - in: path
        name: ip
        required: true
        schema:
          type: string
    delete:
      tags:
        - diag
      summary: Delete ARP entry
      description: ""
      operationId: DiagDeleteArpEntry
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /diag/auth:
    get:
      tags:
        - diag
      summary: Get list of authentication servers
      description: ""
      operationId: DiagGetAuthServerList
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DiagAuthServerList'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /diag/auth/test:
    post:
      tags:
        - diag
      summary: Perform auth test
      description: ""
      operationId: DiagAuthTest
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DiagAuthTestRequest'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DiagAuthTestResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /diag/backup:
    post:
      tags:
        - diag
      summary: Get a backup of the config as file
      description: ""
      operationId: DiagGetBackup
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DiagBackupRequest'
      responses:
        '200':
          description: ok
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /diag/backup/diff:
    get:
      tags:
        - diag
      summary: Get a diff of two backups
      description: ""
      operationId: DiagGetBackupDiff
      parameters:
        - in: query
          name: t1
          schema:
            type: integer
        - in: query
          name: t2
          schema:
            type: integer
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DiagBackupDiff'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /diag/backup/prior:
    get:
      tags:
        - diag
      summary: Get a list of previous backup
      description: ""
      operationId: DiagGetPriorBackupsList
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DiagPriorBackupInfo'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /diag/backup/priorbackup/{time}:
    parameters:
      - in: path
        name: time
        required: true
        schema:
          type: string
    get:
      tags:
        - diag
      summary: Get a prior backup
      description: ""
      operationId: DiagGetPriorBackup
      responses:
        '200':
          description: ok
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /diag/backup/restore:
    post:
      tags:
        - diag
      summary: Restore a backup of the config from file
      description: ""
      operationId: DiagRestoreBackup
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                backup:
                  $ref: '#/components/schemas/DiagBackupRequest'
                config:
                  type: string
                  format: binary
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /diag/backup/restorebkp:
    post:
      tags:
        - diag
      summary: Restore from prior backup
      description: ""
      operationId: DiagRestorePriorBackup
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DiagRestorePriorBackupRequst'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /diag/backup/{time}:
    parameters:
      - in: path
        name: time
        required: true
        schema:
          type: string
    delete:
      tags:
        - diag
      summary: Delete a backup of the config
      description: ""
      operationId: DiagDeleteBackup
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /diag/cmd/download:
    get:
      tags:
        - diag
      summary: Download a file
      description: ""
      operationId: DiagCmdGetFile
      parameters:
        - in: query
          name: filename
          schema:
            type: string
      responses:
        '200':
          description: ok
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /diag/cmd/php:
    post:
      tags:
        - diag
      summary: Run PHP code
      description: ""
      operationId: DiagExecutePhpCmd
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DiagPhpCommand'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DiagCommandResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /diag/cmd/shell:
    post:
      tags:
        - diag
      summary: Run a shell command and returns its output
      description: ""
      operationId: DiagExecuteShellCmd
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DiagShellCommand'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DiagCommandResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /diag/cmd/upload:
    post:
      tags:
        - diag
      summary: Upload a file to a specified location
      description: ""
      operationId: DiagCmdUploadFile
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DiagUploadRequest'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DiagUploadResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /diag/console:
    get:
      tags:
        - diag
      summary: |
        Obtain access to the console. Note this is a websocket upgrade
        point and not regular HTTP. The success response below is for
        OpenAPI and not meant as the actual reponse payload. The API
        will launch a virtual terminal instance on the host and stream
        its contents to the client. Client writes are delivered to
        the virtual terminal as is.
      description: ""
      operationId: DiagGetConsole
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    delete:
      tags:
        - diag
      summary: Shutdown web console session
      description: ""
      operationId: DiagShutdownConsole
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /diag/console/sessions:
    get:
      tags:
        - diag
      summary: List open console clients, including remote SSH logins.
      description: ""
      operationId: DiagGetConsoleClients
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConsoleClients'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /diag/control:
    post:
      tags:
        - diag
      summary: Execute system control, such as rebooting
      description: ""
      operationId: DiagSystemControl
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SystemControl'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /diag/dns:
    get:
      tags:
        - diag
      summary: Lookup DNS entry for the given host
      description: ""
      operationId: DiagLookupHostDNS
      parameters:
        - in: query
          name: host
          schema:
            type: string
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DiagDnsLookupResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /diag/dns/alias:
    post:
      tags:
        - diag
      summary: Create a DNS alias
      description: ""
      operationId: DiagDNSCreateAlias
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DnsAliasRequest'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /diag/editfile:
    get:
      tags:
        - diag
      summary: Get file contents for editing
      description: ""
      operationId: DiagGetEditFile
      parameters:
        - in: query
          name: fname
          schema:
            type: string
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EditFileData'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      tags:
        - diag
      summary: Save edited file
      description: ""
      operationId: DiagSaveEditedFile
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EditFileData'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EditFileData'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /diag/limiterinfo:
    get:
      tags:
        - diag
      summary: Return limiter information
      description: ""
      operationId: DiagGetLimiterInfo
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DiagLimiters'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /diag/pcap:
    get:
      tags:
        - diag
      summary: List current or completed packet captures
      description: ""
      operationId: DiagGetPcap
      parameters:
        - in: query
          name: proto
          schema:
            type: string
        - in: query
          name: detail
          schema:
            type: string
        - in: query
          name: dnsquery
          schema:
            type: string
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PacketCapture'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      tags:
        - diag
      summary: Start a new packet capture
      description: ""
      operationId: DiagRunPcap
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PacketCaptureRequest'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PacketCapture'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /diag/pcap/download:
    get:
      tags:
        - diag
      summary: Download packet capture
      description: ""
      operationId: DiagDownloadPcap
      responses:
        '200':
          description: ok
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /diag/pfinfo:
    get:
      tags:
        - diag
      summary: Get pfctl summary
      description: ""
      operationId: DiagGetPfInfo
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfInfoResponse'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /diag/pftop:
    get:
      tags:
        - diag
      summary: Get pftop output
      description: ""
      operationId: DiagGetPftop
      parameters:
        - in: query
          name: viewtype
          schema:
            type: string
        - in: query
          name: filter
          schema:
            type: string
        - in: query
          name: sorttype
          schema:
            type: string
        - in: query
          name: states
          schema:
            type: string
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PftopResponse'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /diag/ping:
    post:
      tags:
        - diag
      summary: Ping target host
      description: ""
      operationId: DiagPing
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DiagPingRequest'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DiagPingResponse'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /diag/routes:
    get:
      tags:
        - diag
      summary: Retrieve routing table
      description: ""
      operationId: DiagGetRoutes
      parameters:
        - in: query
          name: resolve
          schema:
            type: string
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DiagRoutes'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /diag/smart:
    get:
      tags:
        - diag
      summary: Get SMART information
      description: ""
      operationId: DiagGetSmartDevices
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SMARTDevices'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /diag/smart/abort:
    get:
      tags:
        - diag
      summary: Abort SMART test
      description: ""
      operationId: DiagGetSmartAbort
      parameters:
        - in: query
          name: drive
          schema:
            type: string
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SMARTResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /diag/smart/info:
    get:
      tags:
        - diag
      summary: Get SMART info
      description: ""
      operationId: DiagGetSmartInfo
      parameters:
        - in: query
          name: drive
          schema:
            type: string
        - in: query
          name: type
          schema:
            type: string
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SMARTResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /diag/smart/logs:
    get:
      tags:
        - diag
      summary: Get SMART logs
      description: ""
      operationId: DiagGetSmartLogs
      parameters:
        - in: query
          name: drive
          schema:
            type: string
        - in: query
          name: type
          schema:
            type: string
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SMARTResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /diag/smart/test:
    get:
      tags:
        - diag
      summary: Run SMART test
      description: ""
      operationId: DiagGetSmartTest
      parameters:
        - in: query
          name: drive
          schema:
            type: string
        - in: query
          name: type
          schema:
            type: string
        - in: query
          name: status
          schema:
            type: string
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SMARTResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /diag/sockets:
    get:
      tags:
        - diag
      summary: Get socket stats
      description: ""
      operationId: DiagGetSocketStats
      parameters:
        - in: query
          name: filter
          schema:
            type: string
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DiagSocketStats'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /diag/states:
    get:
      tags:
        - diag
      summary: Get state information
      description: ""
      operationId: DiagGetStates
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DiagStates'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    delete:
      tags:
        - diag
      summary: Delete state information
      description: ""
      operationId: DiagDeleteStates
      parameters:
        - in: query
          name: srcip
          schema:
            type: string
        - in: query
          name: dstip
          schema:
            type: string
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /diag/testport:
    get:
      tags:
        - diag
      summary: Get possible source addresses
      description: ""
      operationId: DiagGetSourceAddresses
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestPortSources'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      tags:
        - diag
      summary: Test a network port
      description: ""
      operationId: DiagTestsPort
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TestPortRequest'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestPortResponse'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /diag/traceroute:
    post:
      tags:
        - diag
      summary: Perform traceroute
      description: ""
      operationId: DiagTraceroute
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TracerouteRequest'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TracerouteResponse'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /events:
    get:
      tags:
        - events
      summary: Long poll to wait for events from the system
      description: |
        Detect system events or alerts that need to be attended to.
        Calling this function will block the client, and it should therefore
        be placed on a a dedicated connection from other API requests.
        Each event returned in the events list has an event_id, which
        can be used as a tracker for retrieving the nest set of events.
        
        parameters:
          - last_id: the ID of the event that was last retrieved by the client.
      operationId: GetEvents
      parameters:
        - in: query
          name: last_id
          schema:
            type: integer
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Events'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /firewall/nat:
    get:
      tags:
        - firewall
      summary: Get NAT Rules
      description: ""
      operationId: FirewallGetNAT
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NATRules'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      tags:
        - firewall
      summary: Create NAT rule
      description: ""
      operationId: FirewallCreateNAT
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NATRule'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NATRules'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /firewall/nat/npt:
    get:
      tags:
        - firewall
      summary: Get NPt (IPv6 Network Prefix Translation) Rules
      description: ""
      operationId: FirewallGetNATNpt
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NATNptRules'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      tags:
        - firewall
      summary: |
        Create 1:1 NAT NPt rule
      description: ""
      operationId: FirewallCreateNATNpt
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NATNptRule'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NATNptRules'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /firewall/nat/npt/order:
    post:
      tags:
        - firewall
      summary: Reorder NPt NAT rules
      description: ""
      operationId: FirewallOrderNATNptRules
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FWRuleOrder'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /firewall/nat/npt/toggle/{id}:
    parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
    put:
      tags:
        - firewall
      summary: Toggle NPt Rule
      description: ""
      operationId: FirewallToggleNATNptRule
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FwIgnoredInput'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FWToggleResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /firewall/nat/npt/{ids}:
    parameters:
      - in: path
        name: ids
        required: true
        schema:
          type: string
    delete:
      tags:
        - firewall
      summary: Delete NAT NPt rules
      description: ""
      operationId: FirewallDeleteNATNptRules
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /firewall/nat/npt/{id}:
    parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
    put:
      tags:
        - firewall
      summary: Update NAT NPt rule
      description: ""
      operationId: FirewallUpdateNATnpt
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NATNptRule'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NATNptUpdateResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /firewall/nat/onetoone:
    get:
      tags:
        - firewall
      summary: |
        Get NAT 1:1 rules
      description: ""
      operationId: FirewallGetNAT1To1Rules
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NAT1To1Rules'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      tags:
        - firewall
      summary: |
        Create 1:1 NAT rule
      description: ""
      operationId: FirewallCreateNAT1To1Rule
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NAT1To1Rule'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NAT1To1Rules'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /firewall/nat/onetoone/order:
    post:
      tags:
        - firewall
      summary: |
        Reorder 1:1 NAT rules
      description: ""
      operationId: FirewallOrderNAT1To1Rules
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FWRuleOrder'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /firewall/nat/onetoone/toggle/{id}:
    parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
    put:
      tags:
        - firewall
      summary: |
        Toggle NAT 1:1 rule
      description: ""
      operationId: FirewallToggleNAT1To1Rule
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FwIgnoredInput'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FWToggleResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /firewall/nat/onetoone/{ids}:
    parameters:
      - in: path
        name: ids
        required: true
        schema:
          type: string
    delete:
      tags:
        - firewall
      summary: |
        Delete NAT 1:1 rules
      description: ""
      operationId: FirewallDeleteNAT1To1Rules
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /firewall/nat/onetoone/{id}:
    parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
    put:
      tags:
        - firewall
      summary: |
        Update NAT 1:1 rule
      description: ""
      operationId: FirewallUpdateNAT1To1Rule
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NAT1To1Rule'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NAT1To1UpdateResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /firewall/nat/order:
    post:
      tags:
        - firewall
      summary: Reorder NAT rules
      description: ""
      operationId: FirewallOrderNATRules
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FWRuleOrder'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /firewall/nat/outbound:
    get:
      tags:
        - firewall
      summary: Get NAT Outbound Rules
      description: ""
      operationId: FirewallGetNATOut
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NATOutboundRules'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      tags:
        - firewall
      summary: Create NAT outbound rule
      description: ""
      operationId: FirewallCreateNATOut
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NATOutboundRule'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NATOutboundRules'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /firewall/nat/outbound/order:
    post:
      tags:
        - firewall
      summary: Reorder NAT outbound rules
      description: ""
      operationId: FirewallOrderNATOut
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FWRuleOrder'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /firewall/nat/outbound/toggle/{id}:
    parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
    put:
      tags:
        - firewall
      summary: Toggle NAT Outbound rule
      description: ""
      operationId: FirewallToggleNATOut
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FwIgnoredInput'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FWToggleResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /firewall/nat/outbound/{ids}:
    parameters:
      - in: path
        name: ids
        required: true
        schema:
          type: string
    delete:
      tags:
        - firewall
      summary: Delete NAT out rules
      description: ""
      operationId: FirewallDeleteNATOut
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /firewall/nat/outbound/{id}:
    parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
    put:
      tags:
        - firewall
      summary: Update NAT Outbound Rule
      description: ""
      operationId: FirewallUpdateNATOut
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NATOutboundRule'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NATOutUpdateResponse'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /firewall/nat/toggle/{id}:
    parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
    put:
      tags:
        - firewall
      summary: Toggle NAT Rule
      description: ""
      operationId: FirewallToggleNATRule
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FwIgnoredInput'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FWToggleResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /firewall/nat/{ids}:
    parameters:
      - in: path
        name: ids
        required: true
        schema:
          type: string
    delete:
      tags:
        - firewall
      summary: Delete NAT rules
      description: ""
      operationId: FirewallDeleteNAT
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    put:
      tags:
        - firewall
      summary: Update NAT rule
      description: ""
      operationId: FierwallUpdateNAT
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NATRule'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NATUpdateResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /firewall/pflow:
    get:
      tags:
        - firewall
      summary: Get Global Packet Flow Options
      description: ""
      operationId: FirewallGetPFlow
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PFlowGlobalOptions'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      tags:
        - firewall
      summary: Change Global Packet Flow Options
      description: ""
      operationId: FirewallSetPFlow
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PFlowOptions'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /firewall/pflow/exporters:
    post:
      tags:
        - firewall
      summary: Add Packet Flow Exporters
      description: ""
      operationId: FirewallAddPFlowExporter
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PFlowExporter'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /firewall/pflow/exporters/{id}:
    parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
    put:
      tags:
        - firewall
      summary: Update Packet Flow Exporters
      description: ""
      operationId: FirewallUpdatePFlowExporter
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PFlowExporter'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    delete:
      tags:
        - firewall
      summary: Delete Packet Flow Exporters
      description: ""
      operationId: FirewallDeletePFlowExporter
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /firewall/rules/interface:
    get:
      tags:
        - firewall
      summary: Query rules for interface
      description: ""
      operationId: GetFWInterfaces
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FWFirewallInterfaces'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /firewall/rules/interface/{interface}:
    parameters:
      - in: path
        name: interface
        required: true
        schema:
          type: string
    get:
      tags:
        - firewall
      summary: Query rules and separators
      description: ""
      operationId: GetFirewallRules
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FWRules'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      tags:
        - firewall
      summary: Append rule to the firewall
      description: ""
      operationId: AppendFirewallRule
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FWFilterRule'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FWFilterRule'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /firewall/rules/interface/{interface}/bogon:
    parameters:
      - in: path
        name: interface
        required: true
        schema:
          type: string
    get:
      tags:
        - firewall
      summary: Get bogon rule for the specified interface
      description: ""
      operationId: QueryBogonRule
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FWBogonRule'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      tags:
        - firewall
      summary: Toggles the bogon rule
      description: ""
      operationId: ToggleBogonRule
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FWBogonState'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /firewall/rules/interface/{interface}/copy:
    parameters:
      - in: path
        name: interface
        required: true
        schema:
          type: string
    post:
      tags:
        - firewall
      summary: Bulk copy of rules to target interface
      description: ""
      operationId: CopyFirewallRules
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FwBulkCopy'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /firewall/rules/interface/{interface}/delete:
    parameters:
      - in: path
        name: interface
        required: true
        schema:
          type: string
    post:
      tags:
        - firewall
      summary: Bulk delete of rules
      description: ""
      operationId: DeleteFirewallRules
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FwBulkDelete'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /firewall/rules/interface/{interface}/reorder:
    parameters:
      - in: path
        name: interface
        required: true
        schema:
          type: string
    post:
      tags:
        - firewall
      summary: Reorder rules and separators
      description: ""
      operationId: ReorderFirewallRules
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FWRulesOrder'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /firewall/rules/interface/{interface}/separators:
    parameters:
      - in: path
        name: interface
        required: true
        schema:
          type: string
    post:
      tags:
        - firewall
      summary: Create separator before/after a rule identified by its id
      description: ""
      operationId: InsertFirewallSeparator
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InsertFilterSeparator'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Separator'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /firewall/rules/interface/{interface}/separators/{id}:
    parameters:
      - in: path
        name: interface
        required: true
        schema:
          type: string
      - in: path
        name: id
        required: true
        schema:
          type: string
    delete:
      tags:
        - firewall
      summary: Delete firewall rule separator identified by id
      description: ""
      operationId: DeleteFirewallSeparator
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /firewall/rules/interface/{interface}/toggle:
    parameters:
      - in: path
        name: interface
        required: true
        schema:
          type: string
    post:
      tags:
        - firewall
      summary: Bulk toggle of rules
      description: ""
      operationId: ToggleFirewallRules
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FwBulkToggle'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /firewall/rules/interface/{interface}/toggle/{id}:
    parameters:
      - in: path
        name: interface
        required: true
        schema:
          type: string
      - in: path
        name: id
        required: true
        schema:
          type: string
    post:
      tags:
        - firewall
      summary: Toggle rule by id
      description: ""
      operationId: ToggleFirewallRule
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FwRuleToggle'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /firewall/rules/interface/{interface}/{id}:
    parameters:
      - in: path
        name: interface
        required: true
        schema:
          type: string
      - in: path
        name: id
        required: true
        schema:
          type: string
    patch:
      tags:
        - firewall
      summary: Update rule identified by id
      description: ""
      operationId: UpdateFirewallRule
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FWFilterRule'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FWFilterRule'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      tags:
        - firewall
      summary: Add rule before/after other rule identified by its id
      description: ""
      operationId: InsertFirewallRule
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InsertFilterRule'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FWFilterRule'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    delete:
      tags:
        - firewall
      summary: Deletes a rule by its id
      description: ""
      operationId: DeleteFirewallRule
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /firewall/schedules:
    get:
      tags:
        - firewall
      summary: Get Firewall Schedules
      description: ""
      operationId: FirewallGetSchedules
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FWSchedules'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      tags:
        - firewall
      summary: Add Firewall Schedule
      description: ""
      operationId: FirewallAddSchedule
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FWSchedule'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /firewall/schedules/{id}:
    parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
    put:
      tags:
        - firewall
      summary: Update Firewall Schedule
      description: ""
      operationId: FirewallUpdateSchedule
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FWSchedule'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    delete:
      tags:
        - firewall
      summary: Delete schedule
      description: ""
      operationId: FirewallDeleteSchedule
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /firewall/virtualip:
    get:
      tags:
        - firewall
      summary: List Virtual IPs
      description: ""
      operationId: FirewallGetVirtualIPs
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VirtualIPs'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      tags:
        - firewall
      summary: Add Virtual IP
      description: ""
      operationId: FirewallSetVirtualIP
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VirtualIP'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VirtualIPResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /firewall/virtualip/{id}:
    parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
    delete:
      tags:
        - firewall
      summary: Delete Virtual IP
      description: ""
      operationId: FirewallDeleteVirtualIP
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    put:
      tags:
        - firewall
      summary: Update Virtual IP
      description: ""
      operationId: FirewallUpdateVirtualIP
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VirtualIP'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VirtualIPResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /interfaces:
    get:
      tags:
        - interfaces
      summary: Get network interfaces
      description: ""
      operationId: GetInterfaces
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InterfacesSimple'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    put:
      tags:
        - interfaces
      summary: Update All interfaces
      description: ""
      operationId: UpdateInterfaces
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InterfacesSimple'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      tags:
        - interfaces
      summary: Add Interface
      description: ""
      operationId: AddInterface
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Interface'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NewInterfaceResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /interfaces/bridge:
    get:
      tags:
        - interfaces
      summary: Get Bridges
      description: ""
      operationId: GetBridgeInterfaces
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BridgeInterfaces'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      tags:
        - interfaces
      summary: Add bridge interface
      description: ""
      operationId: AddBridgeInterface
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BridgeInterface'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /interfaces/bridge/{name}:
    parameters:
      - in: path
        name: name
        required: true
        schema:
          type: string
    put:
      tags:
        - interfaces
      summary: Update bridge interface
      description: ""
      operationId: SetBridgeInterface
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BridgeInterface'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    delete:
      tags:
        - interfaces
      summary: Remove bridge interface
      description: ""
      operationId: RemoveBridgeInterface
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /interfaces/descriptors:
    get:
      tags:
        - interfaces
      summary: Get a interface descriptors
      description: ""
      operationId: GetInterfaceDescriptors
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InterfaceDescriptors'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /interfaces/friendly:
    get:
      tags:
        - interfaces
      summary: Get interfaces
      description: ""
      operationId: GetInterfacesFriendly
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InterfacesFriendly'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /interfaces/gif:
    get:
      tags:
        - interfaces
      summary: Get GIF interfaces
      description: ""
      operationId: GetGIFs
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GIFInterfaces'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      tags:
        - interfaces
      summary: Add GIF interface
      description: ""
      operationId: AddGIF
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GIFInterface'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /interfaces/gif/{name}:
    parameters:
      - in: path
        name: name
        required: true
        schema:
          type: string
    put:
      tags:
        - interfaces
      summary: Update GIF interface
      description: ""
      operationId: SetGIF
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GIFInterface'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    delete:
      tags:
        - interfaces
      summary: Delete GIF interface
      description: ""
      operationId: DeleteGIF
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /interfaces/gre:
    get:
      tags:
        - interfaces
      summary: Get interfaces
      description: ""
      operationId: GetGREs
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GREInterfaces'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      tags:
        - interfaces
      summary: Adding GRE interface
      description: ""
      operationId: AddGRE
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GREInterface'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /interfaces/gre/{name}:
    parameters:
      - in: path
        name: name
        required: true
        schema:
          type: string
    put:
      tags:
        - interfaces
      summary: Update GRE interface
      description: ""
      operationId: SetGRE
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GREInterface'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    delete:
      tags:
        - interfaces
      summary: Delete GRE interface
      description: ""
      operationId: DeleteGRE
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /interfaces/groups:
    get:
      tags:
        - interfaces
      summary: Get interface groups
      description: ""
      operationId: GetInterfaceGroups
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InterfaceGroups'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      tags:
        - interfaces
      summary: Add interface group
      description: ""
      operationId: AddInterfaceGroup
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InterfaceGroup'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /interfaces/groups/{name}:
    parameters:
      - in: path
        name: name
        required: true
        schema:
          type: string
    delete:
      tags:
        - interfaces
      summary: Delete interface group
      description: ""
      operationId: DeleteInterfaceGroup
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    put:
      tags:
        - interfaces
      summary: Set interface group
      description: ""
      operationId: SetInterfaceGroup
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InterfaceGroup'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /interfaces/lagg:
    get:
      tags:
        - interfaces
      summary: Get interfaces
      description: ""
      operationId: GetLAGGs
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LAGGInterfaces'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      tags:
        - interfaces
      summary: Add LAGG interface
      description: ""
      operationId: AddLAGG
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LAGGInterface'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /interfaces/lagg/{name}:
    parameters:
      - in: path
        name: name
        required: true
        schema:
          type: string
    put:
      tags:
        - interfaces
      summary: Update LAGG interface
      description: ""
      operationId: SetLAGG
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LAGGInterface'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    delete:
      tags:
        - interfaces
      summary: Delete LAGG interface
      description: ""
      operationId: DeleteLAGG
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /interfaces/lan:
    get:
      tags:
        - interfaces
      summary: Get LAN interface
      description: ""
      operationId: GetLAN
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Interface'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    put:
      tags:
        - interfaces
      summary: Update LAN interface
      description: ""
      operationId: UpdateLAN
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Interface'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /interfaces/ports:
    get:
      tags:
        - interfaces
      summary: |
        Get interface ports.
        The response of ports is a map of port-type (e.g. wans, gres) to
        a list of its corresponding datastructure.
      description: ""
      operationId: GetInterfacePorts
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InterfacePorts'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /interfaces/ppp:
    get:
      tags:
        - interfaces
      summary: Get interfaces
      description: ""
      operationId: GetPPPInterfaces
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PPPInterfacesModems'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      tags:
        - interfaces
      summary: Add PPP interface
      description: ""
      operationId: AddPPPInterface
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PPPInterface'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /interfaces/ppp/{name}:
    parameters:
      - in: path
        name: name
        required: true
        schema:
          type: string
    put:
      tags:
        - interfaces
      summary: Update PPP interface
      description: ""
      operationId: SetPPPInterface
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PPPInterface'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    delete:
      tags:
        - interfaces
      summary: Delete PPP interface
      description: ""
      operationId: DeletePPPInterface
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /interfaces/qinq:
    get:
      tags:
        - interfaces
      summary: Get QinQs
      description: ""
      operationId: GetQinQs
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QinQInterfaces'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      tags:
        - interfaces
      summary: Add QinQ
      description: ""
      operationId: AddQinQ
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/QinQInterface'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /interfaces/qinq/{name}:
    parameters:
      - in: path
        name: name
        required: true
        schema:
          type: string
    put:
      tags:
        - interfaces
      summary: Update QinQ
      description: ""
      operationId: SetQinQ
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/QinQInterface'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    delete:
      tags:
        - interfaces
      summary: Delete QinQ
      description: ""
      operationId: DeleteQinQ
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /interfaces/vlan:
    get:
      tags:
        - interfaces
      summary: Get VLANs
      description: ""
      operationId: GetVLANs
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VLANInterfaces'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      tags:
        - interfaces
      summary: Add VLAN interface
      description: ""
      operationId: AddVLAN
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VLANInterface'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /interfaces/vlan/{name}:
    parameters:
      - in: path
        name: name
        required: true
        schema:
          type: string
    put:
      tags:
        - interfaces
      summary: Update VLAN interface
      description: ""
      operationId: SetVLAN
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VLANInterface'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    delete:
      tags:
        - interfaces
      summary: Delete VLAN interface
      description: ""
      operationId: DeleteVLAN
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /interfaces/wan:
    get:
      tags:
        - interfaces
      summary: Get WAN interface
      description: ""
      operationId: GetWAN
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Interface'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    put:
      tags:
        - interfaces
      summary: Update WAN interface
      description: ""
      operationId: UpdateWAN
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Interface'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /interfaces/wireless:
    get:
      tags:
        - interfaces
      summary: Get Wireless interfaces
      description: ""
      operationId: GetWirelessInterfaces
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WirelessInterfaces'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      tags:
        - interfaces
      summary: Add Wireless Interface
      description: ""
      operationId: AddWirelessInterface
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WirelessInterface'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /interfaces/wireless/{id}:
    parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
    put:
      tags:
        - interfaces
      summary: Set Wireless interfaces
      description: ""
      operationId: SetWirelessInterface
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WirelessInterface'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    delete:
      tags:
        - interfaces
      summary: Delete Wireless interface
      description: ""
      operationId: DeleteWirelessInterface
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /interfaces/{name}:
    parameters:
      - in: path
        name: name
        required: true
        schema:
          type: string
    get:
      tags:
        - interfaces
      summary: Get interface by its name
      description: ""
      operationId: GetInterface
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Interface'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    delete:
      tags:
        - interfaces
      summary: Delete an interface
      description: ""
      operationId: DeleteInterface
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    put:
      tags:
        - interfaces
      summary: Update an interface
      description: ""
      operationId: SetInterface
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Interface'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /login:
    post:
      tags:
        - login
      summary: Authenticate with the controller.
      description: |
        Login to pfSense. If the JWT access token is not provided, then a new
        one is allocated. A JWT refresh token is also applied to cookie. The client
        can refresh the access token, while the refresh token is still valid, by
        calling RefreshAccessToken (POST /login/refresh).
      operationId: Login
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LoginCredentials'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LoginResponse'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /login/refresh:
    post:
      tags:
        - login
      summary: |
        Refresh the JWT access token. The refresh token cookie must be valid
        for a successful refresh.
      description: ""
      operationId: RefreshAccessToken
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RefreshTokenParam'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LoginResponse'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /mim/controller/identity:
    get:
      tags:
        - mim
      summary: Get this Controller's MIM identity, which is used to register it on the managed device.
      description: |
        The Controller Summary payload which is provided to a remote pfSense device to
        store in its configuration and is used for it establish a MIM VPN connection
        to the controller.
      operationId: GetMIMControllerSummary
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ControllerSummary'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /mim/controllers:
    get:
      tags:
        - mim
      summary: Get a list of configured controllers managing this device and information about this device
      description: ""
      operationId: GetControllers
      parameters:
        - in: query
          name: detailed
          schema:
            type: boolean
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ControllersList'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      tags:
        - mim
      summary: Add/change a management controller with its public key on the pfsense host
      description: |
        Adding the controller will initiate a Netgard connection to it. The device will
        continue to issue a connection request every 10 seconds while the Controller
        has not added the device to its configuration.
      operationId: SetController
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ControllerIdentity'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ControllerInfo'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /mim/controllers/id/{key}:
    parameters:
      - in: path
        name: key
        required: true
        schema:
          type: string
    get:
      tags:
        - mim
      summary: Get stored controller information, by its key ID
      description: ""
      operationId: GetMIMController
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ControllerInfo'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    delete:
      tags:
        - mim
      summary: Delete controller entry. The key can be hex or base64-URL encoded.
      description: ""
      operationId: DeleteMIMController
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /mim/device/identity:
    get:
      tags:
        - mim
      summary: Gets the device's details to register with the MIM controller.
      description: |
        Get the required information for the MiM controller to manage this device. It includes
        this device's public keys for API Noise handshaking and VPN connection.
      operationId: GetDeviceIdentity
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeviceIdentity'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /mim/device/pubkey:
    post:
      tags:
        - mim
      summary: Sets the pfSense device's public key which is used by a controller to manage it.
      description: |
        The ED25519 public key set to the device is used for secure Noise handshaking
        between the controller and the device to ensure the establish trust. The public
        key part is exported in the `DeviceIdentity` structure and is what should be
        updated on the controller when this device's key is changed.
        
        This function is intended to be used on the device to change its ED25519 public key.
      operationId: SetDevicePublicKey
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DevicePublicKeyOption'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DevicePublicKeyOption'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /mim/devices:
    get:
      tags:
        - mim
      summary: Get controlled devices
      description: ""
      operationId: GetControlledDevices
      parameters:
        - in: query
          name: tags
          schema:
            type: string
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ControlledDevices'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      tags:
        - mim
      summary: |
        Add device to be controlled. This will also attempt to connect to
        the device and perform an authentication handshake with it.
      description: ""
      operationId: AddControlledDevice
      requestBody:
        required: true
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/ControlledDevice'
                - $ref: '#/components/schemas/DeviceIdentity'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ControlledDevice'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /mim/devices/certificate:
    get:
      tags:
        - mim
      summary: Get certificates for controlled devices
      description: ""
      operationId: GetControlledDeviceCerts
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ControlledDeviceCerts'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      tags:
        - mim
      summary: Add/update certificate for controlled devices
      description: ""
      operationId: MakeControlledDeviceCert
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateControlledDeviceCert'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ControlledDeviceCert'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /mim/devices/certificate/{cert}:
    parameters:
      - in: path
        name: cert
        required: true
        schema:
          type: string
    delete:
      tags:
        - mim
      summary: Delete certificate
      description: ""
      operationId: DeleteControlledDeviceCert
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /mim/devices/device/{device_id}:
    parameters:
      - in: path
        name: device_id
        required: true
        schema:
          type: string
    patch:
      tags:
        - mim
      summary: |
        Update device's settings, which can include its VPN keys or tags.
        Only parameters provided will be updated
      description: ""
      operationId: SetControlledDevice
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ControlledDevice'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ControlledDevice'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    delete:
      tags:
        - mim
      summary: Remove the device from the controller
      description: ""
      operationId: DeleteControlledDevice
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /mim/devices/tag:
    post:
      tags:
        - mim
      summary: add new tag to the specified devices
      description: ""
      operationId: SetTagsToDevices
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeviceTagOption'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /mim/devices/tag/{tag}:
    parameters:
      - in: path
        name: tag
        required: true
        schema:
          type: string
    delete:
      tags:
        - mim
      summary: Delete tag, removing it from applied devices.
      description: ""
      operationId: DeleteDeviceTag
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /mim/devices/tag/{tag}/device/{device_id}:
    parameters:
      - in: path
        name: tag
        required: true
        schema:
          type: string
      - in: path
        name: device_id
        required: true
        schema:
          type: string
    delete:
      tags:
        - mim
      summary: Remove the tag from the specified device. If tag == "*" then remove all tags from the device.
      description: ""
      operationId: RemoveDeviceTag
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ControlledDevice'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /services/acb:
    get:
      tags:
        - services
      summary: List backups
      description: ""
      operationId: GetACBList
      parameters:
        - in: query
          name: userkey
          schema:
            type: string
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ACBList'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /services/acb/backup:
    post:
      tags:
        - services
      summary: Perform a backup
      description: ""
      operationId: BackupACB
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ACBManualBackupRequest'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /services/acb/bkp:
    get:
      tags:
        - services
      summary: Retrieve backup
      description: ""
      operationId: GetACB
      parameters:
        - in: query
          name: userkey
          schema:
            type: string
        - in: query
          name: revision
          schema:
            type: string
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrievedBackup'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /services/acb/bkp/{timestamp}:
    parameters:
      - in: path
        name: timestamp
        required: true
        schema:
          type: string
    delete:
      tags:
        - services
      summary: Delete backup
      description: ""
      operationId: DeleteACB
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /services/acb/config:
    get:
      tags:
        - services
      summary: Get ACB config
      description: ""
      operationId: GetACBConfig
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ACBConfigInfo'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      tags:
        - services
      summary: Save ACB config
      description: ""
      operationId: SaveACBConfig
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ACBConfig'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /services/acb/restore:
    post:
      tags:
        - services
      summary: Restore from ACB backup
      description: ""
      operationId: RestoreACB
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ACBRestoreRequest'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /services/act:
    post:
      tags:
        - services
      summary: Perform action on System Service
      description: ""
      operationId: ServicesAction
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ServicesActionReq'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /services/capportal:
    get:
      tags:
        - services
      summary: Get Captive Portal Zones
      description: ""
      operationId: GetCaptivePortals
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CaptivePortals'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      tags:
        - services
      summary: Set a Captive Portal configuration
      description: ""
      operationId: SetCaptivePortal
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CaptivePortalConfigReq'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /services/capportal/disconnect:
    post:
      tags:
        - services
      summary: Disconnect some or all users from Captive Portal
      description: ""
      operationId: DoCaptivePortalDisconnect
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CaptivePortalDisconnectRequest'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /services/capportal/status/{id}:
    parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
    get:
      tags:
        - services
      summary: Get the status of current active users in a zone.
      description: ""
      operationId: GetCaptivePortalStatus
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CaptivePortalStatus'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /services/capportal/{id}:
    parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
    get:
      tags:
        - services
      summary: Get a specific Captive Portal configuration
      description: ""
      operationId: GetCaptivePortal
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CaptivePortalInfo'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    delete:
      tags:
        - services
      summary: Delete a specific Captive Portal configuration
      description: ""
      operationId: DeleteCaptivePortal
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /services/carp/enabled:
    post:
      tags:
        - services
      summary: Enable/Disable the CARP service
      description: ""
      operationId: SetCARPEnabled
      parameters:
        - in: query
          name: enabled
          schema:
            type: boolean
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CARPStatus'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /services/carp/maintenancemode:
    post:
      tags:
        - services
      summary: Enable/Disable persistent maintenance mode
      description: ""
      operationId: SetCARPMaintenanceEnabled
      parameters:
        - in: query
          name: enabled
          schema:
            type: boolean
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CARPStatus'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /services/carp/resetdemotion:
    post:
      tags:
        - services
      summary: Reset demotions and return if any problems were detected (carp_detected_problems != 0)
      description: ""
      operationId: DoCARPResetDemotion
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CARPResetDemotionResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /services/carp/status:
    get:
      tags:
        - services
      summary: Get the current status of any active CARP clusters
      description: ""
      operationId: GetCARPStatus
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CARPStatus'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /services/dhcp-relay/v4:
    get:
      tags:
        - services
      summary: Get current DHCP over IPv4 Relay configuration
      description: ""
      operationId: GetDhcpV4RelayConfig
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DhcpRelayConfig'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      tags:
        - services
      summary: Set DHCP over IPv4 Relay configuration
      description: ""
      operationId: SetDhcpV4RelayConfig
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /services/dhcp-relay/v4/toggle:
    post:
      tags:
        - services
      summary: Toggle DHCP over IPv4 Relay configuration
      description: ""
      operationId: ToggleDhcpV4Relay
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DhcpRelayToggle'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /services/dhcp-relay/v6:
    get:
      tags:
        - services
      summary: Get current DHCP over IPv6 Relay configuration
      description: ""
      operationId: GetDhcpV6RelayConfig
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DhcpRelayConfig'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      tags:
        - services
      summary: Set DHCP over IPv6 Relay configuration
      description: ""
      operationId: SetDhcpV6RelayConfig
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /services/dhcp-relay/v6/toggle:
    post:
      tags:
        - services
      summary: Toggle DHCP over IPv6 Relay configuration
      description: ""
      operationId: ToggleDhcpV6Relay
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DhcpRelayToggle'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /services/dhcp-server:
    get:
      tags:
        - services
      summary: Get current configuration of the DHCP server
      description: ""
      operationId: GetDhcpdConfig
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DhcpdConfig'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    put:
      tags:
        - services
      summary: Set new DHCP server configuration
      description: ""
      operationId: SetDhcpdConfig
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DhcpdConfig'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /services/dhcp-server/{version}/address-pools/{iface}:
    parameters:
      - in: path
        name: version
        required: true
        schema:
          type: string
      - in: path
        name: iface
        required: true
        schema:
          type: string
    get:
      tags:
        - services
      summary: List all address pools for an interface
      description: ""
      operationId: ListDhcpdAddressPools
      parameters:
        - in: path
          name: version
          required: true
          schema:
            type: string
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DhcpAddressPools'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    put:
      tags:
        - services
      summary: Create a address pool for a given interface
      description: ""
      operationId: CreateDhcpdAddressPool
      parameters:
        - in: path
          name: version
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DhcpAddressPool'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DhcpAddressPool'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /services/dhcp-server/{version}/address-pools/{iface}/{id}:
    parameters:
      - in: path
        name: version
        required: true
        schema:
          type: string
      - in: path
        name: iface
        required: true
        schema:
          type: string
      - in: path
        name: id
        required: true
        schema:
          type: string
    patch:
      tags:
        - services
      summary: Update address pool
      description: ""
      operationId: UpdateDhcpdAddressPool
      parameters:
        - in: path
          name: version
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DhcpAddressPool'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    delete:
      tags:
        - services
      summary: Delete address pool by its id
      description: ""
      operationId: DeleteDhcpAddressPool
      parameters:
        - in: path
          name: version
          required: true
          schema:
            type: string
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /services/dhcp-server/{version}/interface:
    parameters:
      - in: path
        name: version
        required: true
        schema:
          type: string
    get:
      tags:
        - services
      summary: Get a list of all available interfaces
      description: ""
      operationId: GetDhcpdInterfaces
      parameters:
        - in: path
          name: version
          required: true
          schema:
            type: string
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DhcpInterfaces'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /services/dhcp-server/{version}/interface/{iface}:
    parameters:
      - in: path
        name: version
        required: true
        schema:
          type: string
      - in: path
        name: iface
        required: true
        schema:
          type: string
    get:
      tags:
        - services
      summary: Get the configuration for the interface
      description: ""
      operationId: GetDhcpdInterfaceConfig
      parameters:
        - in: path
          name: version
          required: true
          schema:
            type: string
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DhcpInterfaceConfig'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    put:
      tags:
        - services
      summary: Set interface DHCP configuration
      description: ""
      operationId: SetDhcpdInterfaceConfig
      parameters:
        - in: path
          name: version
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DhcpInterfaceConfig'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /services/dhcp-server/{version}/static-mappings/{iface}:
    parameters:
      - in: path
        name: version
        required: true
        schema:
          type: string
      - in: path
        name: iface
        required: true
        schema:
          type: string
    get:
      tags:
        - services
      summary: List all static mappings for an interface
      description: ""
      operationId: ListDhcpdStaticMappings
      parameters:
        - in: path
          name: version
          required: true
          schema:
            type: string
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DhcpStaticMappings'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    put:
      tags:
        - services
      summary: Create a static mapping for a given interface
      description: ""
      operationId: CreateDhcpdStaticMapping
      parameters:
        - in: path
          name: version
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DhcpStaticMapping'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DhcpStaticMapping'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /services/dhcp-server/{version}/static-mappings/{iface}/{id}:
    parameters:
      - in: path
        name: version
        required: true
        schema:
          type: string
      - in: path
        name: iface
        required: true
        schema:
          type: string
      - in: path
        name: id
        required: true
        schema:
          type: string
    patch:
      tags:
        - services
      summary: Update static mapping
      description: ""
      operationId: UpdateDhcpdStaticMapping
      parameters:
        - in: path
          name: version
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DhcpStaticMapping'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    delete:
      tags:
        - services
      summary: Delete static mapping by its id
      description: ""
      operationId: DeleteDhcpdStaticMapping
      parameters:
        - in: path
          name: version
          required: true
          schema:
            type: string
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /services/dhcp/leases:
    get:
      tags:
        - services
      summary: List DHCP leases
      description: ""
      operationId: GetDHCPLeases
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DHCPLeases'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /services/dhcp/leases/{ip}:
    parameters:
      - in: path
        name: ip
        required: true
        schema:
          type: string
    delete:
      tags:
        - services
      summary: Delete DHCP lease
      description: ""
      operationId: DeleteDHCPLease
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /services/dhcp/v4:
    delete:
      tags:
        - services
      summary: Delete all IPv4 DHCP leases
      description: ""
      operationId: DeleteDHCPAllIPv4Leases
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /services/dhcp/v6:
    delete:
      tags:
        - services
      summary: Delete all IPv6 DHCP leases
      description: ""
      operationId: DeleteDHCPAllIPv6Leases
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /services/dnsmasq:
    get:
      tags:
        - services
      summary: Get DNS Forwarder config
      description: ""
      operationId: GetDNSForwarderConfig
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DNSForwarderConfigInfo'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      tags:
        - services
      summary: Update DNS Forwarder config
      description: ""
      operationId: SetDNSForwarderConfig
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DNSForwarderUpdateReq'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /services/dnsresolver:
    get:
      tags:
        - services
      summary: Get DNS Resolver config
      description: ""
      operationId: GetDNSResolverConfig
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DNSResolverConfigInfo'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      tags:
        - services
      summary: Update DNS Resolver config
      description: ""
      operationId: SetDNSResolverConfig
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DNSResolverUpdateReq'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /services/dnsresolver/status:
    get:
      tags:
        - services
      summary: Get the status of the DNS resolver
      description: ""
      operationId: GetDnsResolverStatus
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DNSResolverStatus'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /services/dyndns:
    get:
      tags:
        - services
      summary: Get Dynamic DNS config
      description: ""
      operationId: GetDynDNSConfig
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DynDNSConfigInfo'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      tags:
        - services
      summary: Set Dynamic DNS config
      description: ""
      operationId: SetDynDNSConfig
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DynDNSUpdateReq'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /services/igmpproxy:
    get:
      tags:
        - services
      summary: Get IGMP proxies
      description: ""
      operationId: GetIGMPProxies
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IGMPProxies'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      tags:
        - services
      summary: Add IGMP proxy
      description: ""
      operationId: SetIGMPProxy
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IGMPProxiesReq'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /services/igmpproxy/settings:
    post:
      tags:
        - services
      summary: Update IGMP proxy
      description: ""
      operationId: UpdateIGMPProxySettings
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IGMPProxySettings'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /services/igmpproxy/{id}:
    parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
    post:
      tags:
        - services
      summary: Update IGMP proxy
      description: ""
      operationId: UpdateIGMPProxy
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateProxyReq'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    delete:
      tags:
        - services
      summary: Delete IGMP proxy
      description: ""
      operationId: DeleteIGMPProxy
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /services/ndp:
    get:
      tags:
        - services
      summary: Get NDP Table
      description: ""
      operationId: GetNDPTable
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NDPTable'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    delete:
      tags:
        - services
      summary: Delete NDP Table
      description: ""
      operationId: DeleteNDPTable
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /services/ndp/{ip}:
    parameters:
      - in: path
        name: ip
        required: true
        schema:
          type: string
    delete:
      tags:
        - services
      summary: Delete a NDP Entry
      description: ""
      operationId: DeleteNDP
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /services/ntp:
    get:
      tags:
        - services
      summary: Get current NTP configuration
      description: ""
      operationId: GetNtp
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServicesNtpConfig'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      tags:
        - services
      summary: Updates the NTP configuration
      description: ""
      operationId: SetNtp
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ServicesNtpConfig'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /services/ntp/status:
    get:
      tags:
        - services
      summary: Get the status of current NTP servers
      description: ""
      operationId: GetNtpStatus
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtpStatus'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /services/ntp/stop:
    post:
      tags:
        - services
      summary: Stop ntp service
      description: ""
      operationId: StopNtp
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /services/pppoe:
    get:
      tags:
        - services
      summary: Get PPPoE config
      description: ""
      operationId: GetPPPoE
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PPPoEConfig'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      tags:
        - services
      summary: Set PPPoE config
      description: ""
      operationId: SetPPPoE
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PPPoEConfigReq'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /services/snmp:
    get:
      tags:
        - services
      summary: Get SNMP config
      description: ""
      operationId: GetSNMP
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServicesSNMPConfig'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      tags:
        - services
      summary: Set SNMP config
      description: ""
      operationId: SetSNMP
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ServicesSNMPConfigReq'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /services/status:
    get:
      tags:
        - services
      summary: Get Service Status
      description: ""
      operationId: GetServicesStatus
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServicesStatusList'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /services/upnp:
    get:
      tags:
        - services
      summary: Get UPnP config
      description: ""
      operationId: GetUPnP
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServicesUPnPConfig'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      tags:
        - services
      summary: Set UPnP config
      description: ""
      operationId: SetUPnP
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ServicesUPnPConfigReq'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /services/upnp/acl:
    put:
      tags:
        - services
      summary: Create Service ACL
      description: ""
      operationId: CreateUPnPACL
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateUPnPACL'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UPnPPermUser'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /services/upnp/acl/{id}:
    parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
    delete:
      tags:
        - services
      summary: Delete Service ACL
      description: ""
      operationId: DeleteUPnPACL
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /services/upnp/status:
    get:
      tags:
        - services
      summary: Get a list of active UPnP mappings
      description: ""
      operationId: GetUPnPStatus
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UPnPMappings'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /services/upnp/toggle:
    post:
      tags:
        - services
      summary: Toggle UPNP
      description: ""
      operationId: ToggleUPNP
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ToggleUPNP'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /system:
    get:
      tags:
        - system
      summary: Get system summary
      description: ""
      operationId: GetSystemSummary
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SystemSummary'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /system/advanced/admin:
    get:
      tags:
        - system
      summary: List Advanced Admin
      description: ""
      operationId: GetSystemAdvAdmin
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SystemAdvAdminSetting'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      tags:
        - system
      summary: Update Advanced Admin
      description: ""
      operationId: UpdateSystemAdvAdmin
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SystemAdvAdminSetting'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /system/advanced/firewall:
    get:
      tags:
        - system
      summary: Get Advanced Firewall
      description: ""
      operationId: GetSystemAdvFirewallSetting
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdvFirewallSetting'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      tags:
        - system
      summary: Update Advanced Firewall
      description: ""
      operationId: UpdateSystemAdvFirewallSetting
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AdvFirewall'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /system/advanced/misc:
    get:
      tags:
        - system
      summary: Get Advanced Miscellaneous
      description: ""
      operationId: GetSystemAdvMisc
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdvMiscSetting'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      tags:
        - system
      summary: Update Advanced Miscellaneous
      description: ""
      operationId: UpdateSystemAdvMisc
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AdvMiscSetting'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /system/advanced/networking:
    get:
      tags:
        - system
      summary: List network settings
      description: ""
      operationId: GetAdvancedNetworking
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdvNetworking'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      tags:
        - system
      summary: Set Advanced Network
      description: ""
      operationId: SetSystemAdvNetworking
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AdvNetworkSetting'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /system/advanced/notifications:
    get:
      tags:
        - system
      summary: Get advanced notifications
      description: ""
      operationId: GetSystemAdvNotifications
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdvNotifications'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      tags:
        - system
      summary: Update advanced notifications
      description: ""
      operationId: UpdateSystemAdvNotifications
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AdvNotifications'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /system/advanced/sysctl:
    get:
      tags:
        - system
      summary: List system tunables
      description: ""
      operationId: GetTunables
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Tunables'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      tags:
        - system
      summary: Set/update tunable
      description: ""
      operationId: SetTunable
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TunableRequest'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /system/advanced/sysctl/{id}:
    parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
    delete:
      tags:
        - system
      summary: Delete system tunable
      description: ""
      operationId: DeleteTunable
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /system/advanced/tlscert:
    post:
      tags:
        - system
      summary: |
        Reload TLS certificate. The server will set its TLS certificate to use
        the one specified.
      description: ""
      operationId: UpdateSystemTLSCert
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TLSCertPath'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /system/bootenv:
    get:
      tags:
        - system
      summary: Get all boot environments
      description: ""
      operationId: GetBootenvs
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BootEnvs'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    delete:
      tags:
        - system
      summary: Deletes a bootenv by its name
      description: ""
      operationId: DeleteBootenvs
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    put:
      tags:
        - system
      summary: Creates a bootenv
      description: ""
      operationId: CreateBootenv
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateBootenv'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    patch:
      tags:
        - system
      summary: Updates a bootenv
      description: ""
      operationId: UpdateBootenv
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateBootenv'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /system/bootenv/activate:
    post:
      tags:
        - system
      summary: Activates a bootenv by its name
      description: ""
      operationId: ActivateBootenv
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ActivateBootenv'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BootEnvs'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /system/bootenv/quick:
    post:
      tags:
        - system
      summary: Quickly create a bootenv from default
      description: ""
      operationId: QuickBootenv
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QuickResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /system/certauth:
    get:
      tags:
        - system
      summary: Get a list of Certificate Authorities
      description: ""
      operationId: GetCertAuthorities
      parameters:
        - in: query
          name: withprivkey
          schema:
            type: boolean
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CertAuthorities'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    put:
      tags:
        - system
      summary: Add Certificate Authority
      description: |
        Add a new Certificate Authority. The input must provide one of the method structures
        which contain the parameters to generate the certificate from. If an existing certificate
        is to be used, the method_existing must contain the certificate and the private key
        associated with it.
        
        The input `NewCaCertReq` object must have a name provided, and one of the `method_xxxxx`
        providing the certificate creation options.
      operationId: AddCertAuthority
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NewCaCertReq'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CertAuthority'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /system/certauth/{refid}:
    parameters:
      - in: path
        name: refid
        required: true
        schema:
          type: string
    get:
      tags:
        - system
      summary: Get Certificate Authority details (by its reference ID)
      description: ""
      operationId: GetCertAuthority
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CertAuthority'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    delete:
      tags:
        - system
      summary: Delete Certificate Authority by reference ID
      description: ""
      operationId: DeleteCertAuthority
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CertAuthorities'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      tags:
        - system
      summary: Update Certificate Authority by reference ID
      description: ""
      operationId: UpdateCertAuthority
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateCaCertReq'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CertAuthority'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /system/certauth/{refid}/export-ca:
    parameters:
      - in: path
        name: refid
        required: true
        schema:
          type: string
    get:
      tags:
        - system
      summary: Download the CA certificate
      description: ""
      operationId: DownloadCACert
      responses:
        '200':
          description: ok
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /system/certauth/{refid}/export-key:
    parameters:
      - in: path
        name: refid
        required: true
        schema:
          type: string
    get:
      tags:
        - system
      summary: Download the CA certificate signing key
      description: ""
      operationId: DownloadCAKey
      responses:
        '200':
          description: ok
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /system/certauth/{refid}/renew:
    parameters:
      - in: path
        name: refid
        required: true
        schema:
          type: string
    post:
      tags:
        - system
      summary: Renew/reissue CA certificate
      description: ""
      operationId: RenewCACert
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RenewCertOptions'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CertAuthority'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /system/certificates:
    get:
      tags:
        - system
      summary: Get certificates, or CSRs only (if ?csr_only=true)
      description: ""
      operationId: GetCertificates
      parameters:
        - in: query
          name: csr_only
          schema:
            type: boolean
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CertsConfig'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    put:
      tags:
        - system
      summary: Add certificate, certificate signing request or sign a certificate.
      description: |
        Add a certificate, CSR or sign CSR request. The NewCertReq method can contain one of:
          - method_internal:        CertMethodNew
          - method_existing_pem:    CertMethodExistingPEM
          - method_existing_pkcs12: CertMethodExistingPkcs12
          - method_csr:             CertMethodSigningRequest
          - method_sign:            CertMethodSignCSR
      operationId: AddCertificate
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NewCertReq'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CertificateDetailed'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      tags:
        - system
      summary: Add certificate with PKCS12 upload. The NewCertReq must provide the method_existing_pkcs12 object.
      description: ""
      operationId: ImportPkcs12Certificate
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                reqdata:
                  $ref: '#/components/schemas/NewCertReq'
                pkcs12file:
                  type: string
                  format: binary
            encoding:
                pkcs12file:
                  contentType: application/x-pkcs12
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CertificateDetailed'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /system/certificates/{refid}:
    parameters:
      - in: path
        name: refid
        required: true
        schema:
          type: string
    get:
      tags:
        - system
      summary: Get certificate with reference ID
      description: ""
      operationId: GetCertificate
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CertConfig'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    delete:
      tags:
        - system
      summary: Delete certificate
      description: ""
      operationId: DeleteCertificate
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CertsConfig'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      tags:
        - system
      summary: Update certificate with certificate and private key payloads
      description: ""
      operationId: UpdateCertificate
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateCertReq'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CertificateDetailed'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    patch:
      tags:
        - system
      summary: Update certificate with PKCS12 upload. The PKCS12 payload must be part of a mutl-part form.
      description: ""
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                reqdata:
                  $ref: '#/components/schemas/UpdatePKCS12CertReq'
                pcsk12file:
                  type: string
                  format: binary
            encoding:
                pcsk12file:
                  contentType: application/x-pkcs12
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CertificateDetailed'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /system/certificates/{refid}/renew:
    parameters:
      - in: path
        name: refid
        required: true
        schema:
          type: string
    post:
      tags:
        - system
      summary: Renew/reissue certificate
      description: ""
      operationId: RenewCert
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RenewCertOptions'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CertificateDetailed'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /system/certoptions:
    get:
      tags:
        - system
      summary: Get options for new certificate creation
      description: ""
      operationId: GetCertOptions
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CertOpts'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /system/config/dirty:
    get:
      tags:
        - system
      summary: Get subsystem dirty states
      description: Retrieve the list of subsystem configuration which are pending applying of changes
      operationId: GetDirtySubsystems
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DirtySubsystems'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      tags:
        - system
      summary: Apply pending subsystem changes to the system.
      description: |
        The configuration has pending changes that require a series of being applied.
        It returns the list of subsystems that are still dirty.
      operationId: ApplyDirtyConfig
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApplyDirtyConfigRequest'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DirtySubsystems'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /system/config/export:
    get:
      tags:
        - system
      summary: Downloads the configuration file of the controller
      description: ""
      operationId: ExportConfiguration
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfConfiguration'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /system/config/import:
    put:
      tags:
        - system
      summary: Uploads a configuration file into the controller
      description: ""
      operationId: ImportConfiguration
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PfConfiguration'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /system/crl:
    get:
      tags:
        - system
      summary: Retrieve the CRL configuration
      description: ""
      operationId: GetCRLsList
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CRLEntries'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /system/filterreload/reload:
    post:
      tags:
        - system
      summary: Initiate a manual filter reload
      description: ""
      operationId: DoFilterReload
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /system/filterreload/status:
    get:
      tags:
        - system
      summary: Get the status of an ongoing filter reload
      description: ""
      operationId: GetFilterReloadStatus
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterReloadStatus'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /system/filterreload/sync:
    post:
      tags:
        - system
      summary: Initiate a manual filter sync
      description: ""
      operationId: DoFilterSync
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /system/gateways:
    get:
      tags:
        - system
      summary: List gateways
      description: ""
      operationId: GetGateways
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Gateways'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      tags:
        - system
      summary: Add new gateway
      description: ""
      operationId: AddGateway
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Gateway'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /system/gateways/group_priorities:
    get:
      tags:
        - system
      summary: Get the list of gateways and the priority labeling associated with it
      description: ""
      operationId: GetGatewayPriorities
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GatewayPriorities'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /system/gateways/groups:
    get:
      tags:
        - system
      summary: Get gateway groups
      description: ""
      operationId: GetGatewayGroups
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GatewayGroups'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    put:
      tags:
        - system
      summary: Add gateway group
      description: ""
      operationId: AddGatewayGroup
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GatewayGroup'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GatewayGroups'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /system/gateways/groups/{id}:
    parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
    delete:
      tags:
        - system
      summary: Delete gateway group by its entry index
      description: ""
      operationId: DeleteGatewayGroup
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GatewayGroups'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      tags:
        - system
      summary: Update gateway group
      description: ""
      operationId: UpdateGatewayGroup
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GatewayGroup'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GatewayGroups'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /system/gateways/status:
    get:
      tags:
        - system
      summary: List Gateway status
      description: ""
      operationId: GetGatewaysStatus
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GatewaysStatus'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /system/gateways/{id}:
    parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
    put:
      tags:
        - system
      summary: Update gateway id
      description: ""
      operationId: SetGateway
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Gateway'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    delete:
      tags:
        - system
      summary: Delete gateway
      description: ""
      operationId: DeleteGateway
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /system/initialsetup:
    get:
      tags:
        - system
      summary: Get initial setup
      description: ""
      operationId: GetInitialSetup
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InitialSetup'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /system/interfaces/status:
    get:
      tags:
        - system
      summary: Get the status of any configured interfaces.
      description: ""
      operationId: GetInterfacesStatus
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InterfaceInfoList'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /system/logs:
    post:
      tags:
        - system
      summary: Set the logging configuration
      description: ""
      operationId: SetLogConfiguration
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SyslogConfiguration'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    get:
      tags:
        - system
      summary: Get system log configuration
      description: ""
      operationId: GetSyslogConfig
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SyslogConfiguration'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /system/logs/reset:
    post:
      tags:
        - system
      summary: Reset the local log files and reinitialize as empty files.
      description: ""
      operationId: ResetLogFiles
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /system/logs/{filename}:
    parameters:
      - in: path
        name: filename
        required: true
        schema:
          type: string
    get:
      tags:
        - system
      summary: Get log file contents
      description: |
        Regular log files are returned as a list of records in StdLogs.Logs. For
        firewall logs (filename being "filter" or "firewall"), the log records
        are returned in StdLogs.filter_logs. If the query string "summary=true" is
        provided, then the firewall log summary is returned in StdLogs.filter_summary
        with dictionaries of each category with its tallied values.
      operationId: GetLogs
      parameters:
        - in: query
          name: start
          schema:
            type: string
        - in: query
          name: end
          schema:
            type: string
        - in: query
          name: summary
          schema:
            type: boolean
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StdLogs'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /system/monitoring:
    post:
      tags:
        - system
      summary: Get monitoring data for a given scope and dataset
      description: ""
      operationId: GetMonitoringData
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MonitoringDataRequest'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MonitoringDataResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /system/monitoring/datasets:
    get:
      tags:
        - system
      summary: Get the available monitoring datasets
      description: ""
      operationId: GetMonitoringDatasets
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MonitoringDatasets'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /system/package/available:
    get:
      tags:
        - system
      summary: Get list of available packages
      description: ""
      operationId: GetAvailPackages
      parameters:
        - in: query
          name: remote_check
          schema:
            type: boolean
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Packages'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /system/package/install:
    post:
      tags:
        - system
      summary: Install package(s)
      description: Install specified list of packages. If chunked=true, then the progress of the installation is returned as chunks.
      operationId: InstallPackages
      parameters:
        - in: query
          name: chunked
          schema:
            type: boolean
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InstallPackagesOpt'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InstallPackagesResponse'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /system/package/installed:
    get:
      tags:
        - system
      summary: Get list of installed packages
      description: ""
      operationId: GetInstalledPackages
      parameters:
        - in: query
          name: remote_check
          schema:
            type: boolean
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Packages'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /system/package/name/{name}:
    parameters:
      - in: path
        name: name
        required: true
        schema:
          type: string
    delete:
      tags:
        - system
      summary: Uninstall the named package. Returns the progress of the removal. Use GetInstallProgress to track live progress.
      description: ""
      operationId: RemovePackage
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InstallPackagesResponse'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /system/package/progress:
    get:
      tags:
        - system
      summary: Get install/reinstall/delete progress. If chunked=true, then the progress of the installation is returned as chunks.
      description: ""
      operationId: GetInstallProgress
      parameters:
        - in: query
          name: chunked
          schema:
            type: boolean
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InstallPackagesResponse'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /system/package/reinstall:
    post:
      tags:
        - system
      summary: Reinstall package(s)
      description: Reinstall specified list of packages. If chunked=true, then the progress of the reinstallation is returned as chunks.
      operationId: ReinstallPackages
      parameters:
        - in: query
          name: chunked
          schema:
            type: boolean
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InstallPackagesOpt'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InstallPackagesResponse'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /system/queue/stats:
    get:
      tags:
        - system
      summary: Get stats of traffic shaping queues
      description: ""
      operationId: GetQueueStats
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueueStats'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /system/routes:
    get:
      tags:
        - system
      summary: Determine if there are any pending routing changes (dirty config)
      description: ""
      operationId: GetRoutesDirtyState
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoutesDirtyState'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      tags:
        - system
      summary: Apply routing changes, if there are any
      description: ""
      operationId: ApplyRouteChanges
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RoutesApplyRequest'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /system/routes/static:
    get:
      tags:
        - system
      summary: Get static routes
      description: ""
      operationId: GetStaticRoutes
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StaticRoutes'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      tags:
        - system
      summary: Set static route
      description: ""
      operationId: SetStaticRoute
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StaticRoute'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StaticRoutes'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /system/routes/static/{network}:
    parameters:
      - in: path
        name: network
        required: true
        schema:
          type: string
    delete:
      tags:
        - system
      summary: Delete route by network address
      description: The `network` address must be URL-safe, base64 encoded.
      operationId: DeleteRoute
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /system/routes/static/{network}/{gateway}:
    parameters:
      - in: path
        name: network
        required: true
        schema:
          type: string
      - in: path
        name: gateway
        required: true
        schema:
          type: string
    delete:
      tags:
        - system
      summary: Delete route by network address and gateway name
      description: The `network` address and `gateway` name must be URL-safe, base64 encoded.
      operationId: DeleteRouteWithGw
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /system/serviceproviders:
    get:
      tags:
        - system
      summary: Get all service providers
      description: ""
      operationId: GetServiceProviders
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceProviders'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /system/serviceproviders/{country}:
    parameters:
      - in: path
        name: country
        required: true
        schema:
          type: string
    get:
      tags:
        - system
      summary: Get Service Provider by Country
      description: ""
      operationId: GetServiceProvidersByCountry
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProviderCountry'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /system/serviceproviders/{country}/{provider}:
    parameters:
      - in: path
        name: country
        required: true
        schema:
          type: string
      - in: path
        name: provider
        required: true
        schema:
          type: string
    get:
      tags:
        - system
      summary: Get Service Provider by Provider
      description: ""
      operationId: GetServicePlansByProvider
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceProvider'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /system/setup:
    get:
      tags:
        - system
      summary: Get Setup
      description: ""
      operationId: GetSetup
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SetupSettings'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      tags:
        - system
      summary: Apply Setup
      description: ""
      operationId: SaveSetup
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SetupSettings'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /system/setupwiz:
    get:
      tags:
        - system
      summary: Get setup wizard data
      description: ""
      operationId: GetSetupWizard
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SetupWizard'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      tags:
        - system
      summary: Save setupwizard data
      description: ""
      operationId: SaveSetupWizard
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SetupWizard'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /system/status:
    get:
      tags:
        - system
      summary: Get system status
      description: ""
      operationId: GetStatus
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatusSummary'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /system/status/ifstats:
    get:
      tags:
        - system
      summary: Get network interface stats
      description: ""
      operationId: GetIfStats
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IfStatsSummary'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /system/update:
    get:
      tags:
        - system
      summary: Get system update details
      description: ""
      operationId: GetSystemUpdateInfo
      parameters:
        - in: query
          name: refresh
          schema:
            type: boolean
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SystemUpdateInfo'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      tags:
        - system
      summary: Perform system update
      description: ""
      operationId: PerformSystemUpdate
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SystemUpdateOptions'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SystemUpdateProgress'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /system/update/progress:
    get:
      tags:
        - system
      summary: Poll current update progress
      description: ""
      operationId: GetSystemUpdateProgress
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SystemUpdateProgress'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /system/update/settings:
    get:
      tags:
        - system
      summary: Get system update settings
      description: ""
      operationId: GetSystemUpdateSettings
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SystemUpdateSettings'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      tags:
        - system
      summary: Set system update settings
      description: ""
      operationId: SetSystemUpdateSettings
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SystemUpdateSettingsSet'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SystemUpdateSettings'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /system/users:
    get:
      tags:
        - system
      summary: Get users and groups
      description: ""
      operationId: GetUsersConfig
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsersConfig'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /system/users/authservers:
    get:
      tags:
        - system
      summary: Get auth servers
      description: ""
      operationId: GetAuthServerSettings
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthServers'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    put:
      tags:
        - system
      summary: Add auth server
      description: ""
      operationId: AddAuthServer
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AuthServer'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthServers'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /system/users/authservers/{name}:
    parameters:
      - in: path
        name: name
        required: true
        schema:
          type: string
    post:
      tags:
        - system
      summary: Update auth server
      description: ""
      operationId: UpdateAuthServer
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AuthServer'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthServers'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    delete:
      tags:
        - system
      summary: Delete auth server. Deletion will fail if it is being referenced.
      description: ""
      operationId: DeleteAuthServer
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /system/users/group:
    get:
      tags:
        - system
      summary: Get list of users
      description: ""
      operationId: GetUserGroups
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserGroups'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    put:
      tags:
        - system
      summary: Add group
      description: ""
      operationId: AddGroup
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GroupAddReq'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserGroups'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /system/users/group/{groupname}:
    parameters:
      - in: path
        name: groupname
        required: true
        schema:
          type: string
    post:
      tags:
        - system
      summary: Update group
      description: ""
      operationId: UpdateGroup
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GroupUpdateReq'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserGroups'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    delete:
      tags:
        - system
      summary: Delete a group
      description: ""
      operationId: DeleteGroup
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /system/users/privs:
    get:
      tags:
        - system
      summary: Get definitions of user privileges
      description: ""
      operationId: ListUserPrivileges
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserPrivileges'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /system/users/settings:
    get:
      tags:
        - system
      summary: Get user authentication settings
      description: ""
      operationId: GetUserAuthSettings
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserAuthSettings'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      tags:
        - system
      summary: Set user authentication settings
      description: ""
      operationId: SetUserAuthSettings
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserAuthSettingsReq'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserAuthSettings'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /system/users/user:
    get:
      tags:
        - system
      summary: Get list of users
      description: ""
      operationId: GetUsers
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Users'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    put:
      tags:
        - system
      summary: Add user
      description: ""
      operationId: AddUser
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserAddReq'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Users'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /system/users/user/{username}:
    parameters:
      - in: path
        name: username
        required: true
        schema:
          type: string
    post:
      tags:
        - system
      summary: Update user
      description: ""
      operationId: UpdateUser
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserUpdateReq'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Users'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    delete:
      tags:
        - system
      summary: Delete a user
      description: ""
      operationId: DeleteUser
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /system/widgets/interfaces:
    get:
      tags:
        - system
      summary: Get Interfaces widget
      description: ""
      operationId: GetInterfacesWidgets
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InterfaceWidgets'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /system/widgets/interfacestats:
    get:
      tags:
        - system
      summary: Get Interface statistics widget
      description: ""
      operationId: GetInterfaceStatisticsWidget
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InterfaceStatisticsWidgetResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /system/widgets/ipsec:
    get:
      tags:
        - system
      summary: Get IPSec widget
      description: ""
      operationId: GetIPSecWidget
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IPSecWidget'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /ui/features:
    get:
      tags:
        - ui
      summary: Get current state of UI components
      description: ""
      operationId: GetUIStates
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UIStates'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /vpn/ipsec:
    get:
      tags:
        - vpn
      summary: Get IPSec Phases
      description: ""
      operationId: GetIPSecPhases
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IPSecPhaseList'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /vpn/ipsec/advanced:
    get:
      tags:
        - vpn
      summary: Get IPSec Advanced Configuration
      description: ""
      operationId: GetIPSecConfig
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IPSecConfig'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    put:
      tags:
        - vpn
      summary: Update IPSec Config
      description: ""
      operationId: UpdateIPSecConfig
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IPSecConfig'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /vpn/ipsec/client:
    get:
      tags:
        - vpn
      summary: Get IPSec Client
      description: ""
      operationId: GetIPSecClient
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IPSecClientConfig'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    put:
      tags:
        - vpn
      summary: Update IPSec Client
      description: ""
      operationId: SetIPSecClient
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IPSecClient'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /vpn/ipsec/mobilekey:
    get:
      tags:
        - vpn
      summary: Get IPSec Mobile Keys
      description: ""
      operationId: GetIPSecMobileKeys
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IPSecMobileKeys'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      tags:
        - vpn
      summary: Set IPSec Mobile Key
      description: ""
      operationId: SetIPSecMobileKey
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IPSecMobileKey'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /vpn/ipsec/mobilekey/{name}:
    parameters:
      - in: path
        name: name
        required: true
        schema:
          type: string
    put:
      tags:
        - vpn
      summary: Update IPSec Mobile Key
      description: ""
      operationId: UpdateIPSecMobileKey
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IPSecMobileKey'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    delete:
      tags:
        - vpn
      summary: Delete IPSec Mobile Key
      description: ""
      operationId: DeleteIPSecMobileKey
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /vpn/ipsec/phase1:
    post:
      tags:
        - vpn
      summary: Set IPSec Phase 1
      description: ""
      operationId: SetIPSecPhase1
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Phase1'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /vpn/ipsec/phase1/{ikeid}:
    parameters:
      - in: path
        name: ikeid
        required: true
        schema:
          type: string
    put:
      tags:
        - vpn
      summary: Update IPSec Phase 1
      description: ""
      operationId: UpdateIPSecPhase1
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Phase1'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    delete:
      tags:
        - vpn
      summary: Delete IPSec Phase 1
      description: ""
      operationId: DeleteIPSecPhase1
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /vpn/ipsec/phase2:
    post:
      tags:
        - vpn
      summary: Add IPSec Phase 2
      description: ""
      operationId: SetIPSecPhase2
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Phase2'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /vpn/ipsec/phase2/{reqid}:
    parameters:
      - in: path
        name: reqid
        required: true
        schema:
          type: string
    put:
      tags:
        - vpn
      summary: Set IPSec Phase 2
      description: ""
      operationId: UpdateIPSecPhase2
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Phase2'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    delete:
      tags:
        - vpn
      summary: Delete IPSec Phase 2
      description: ""
      operationId: DeleteIPSecPhase2
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /vpn/ipsec/status:
    get:
      tags:
        - vpn
      summary: Get IPSec Status
      description: ""
      operationId: GetIPSecStatus
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IPSecStatusOverview'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /vpn/l2tp:
    get:
      tags:
        - vpn
      summary: List L2TP
      description: ""
      operationId: GetL2TP
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/L2TPSettings'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      tags:
        - vpn
      summary: Update L2TP
      description: ""
      operationId: UpdateL2TP
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/L2TPConfig'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /vpn/openvpn/clients:
    get:
      tags:
        - vpn
      summary: Get OpenVPN clients
      description: ""
      operationId: GetOpenVPNClients
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OpenVPNClients'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      tags:
        - vpn
      summary: Set OpenVPN client
      description: ""
      operationId: SetOpenVPNClient
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OpenVPNClientConfig'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SetOpenVPNClientResponse'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /vpn/openvpn/clients/{vpnid}:
    parameters:
      - in: path
        name: vpnid
        required: true
        schema:
          type: string
    get:
      tags:
        - vpn
      summary: Get single OpenVPN client
      description: ""
      operationId: GetOpenVPNClient
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OpenVPNClient'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    put:
      tags:
        - vpn
      summary: Update OpenVPN client
      description: ""
      operationId: UpdateOpenVPNClient
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OpenVPNClientConfig'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    delete:
      tags:
        - vpn
      summary: Delete OpenVPN client
      description: ""
      operationId: DeleteOpenVPNClient
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /vpn/openvpn/clientso:
    get:
      tags:
        - vpn
      summary: Get OpenVPN Client Specific Overrides
      description: ""
      operationId: GetOpenVPNCSOs
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OpenVPNCSOs'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      tags:
        - vpn
      summary: Set OpenVPN Client Specific Overrides
      description: ""
      operationId: SetOpenVPNCSO
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OpenVPNCSOConfig'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SetOpenVPNCSOResponse'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /vpn/openvpn/clientso/{id}:
    parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
    get:
      tags:
        - vpn
      summary: Get single OpenVPN Client Specific Overrides
      description: ""
      operationId: GetOpenVPNCSO
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OpenVPNCSO'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    put:
      tags:
        - vpn
      summary: Update OpenVPN Client Specific Overrides
      description: ""
      operationId: UpdateOpenVPNCSO
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OpenVPNCSOConfig'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    delete:
      tags:
        - vpn
      summary: Delete OpenVPN Client Specific Overrides
      description: ""
      operationId: DeleteOpenVPNCSO
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /vpn/openvpn/killclient:
    post:
      tags:
        - vpn
      summary: Kill a client by host, IP or client ID
      description: ""
      operationId: KillClientOpenVPN
      parameters:
        - in: query
          name: port
          schema:
            type: integer
        - in: query
          name: remipp
          schema:
            type: string
        - in: query
          name: clientid
          schema:
            type: string
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /vpn/openvpn/servers:
    get:
      tags:
        - vpn
      summary: Get OpenVPN servers
      description: ""
      operationId: GetOpenVPNServers
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OpenVPNServers'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      tags:
        - vpn
      summary: Set OpenVPN server
      description: ""
      operationId: SetOpenVPNServer
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OpenVPNServerConfig'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SetOpenVPNServerResponse'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /vpn/openvpn/servers/{vpnid}:
    parameters:
      - in: path
        name: vpnid
        required: true
        schema:
          type: string
    get:
      tags:
        - vpn
      summary: Get single OpenVPN server
      description: ""
      operationId: GetOpenVPNServer
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OpenVPNServer'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    put:
      tags:
        - vpn
      summary: Update OpenVPN server
      description: ""
      operationId: UpdateOpenVPNServer
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OpenVPNServerConfig'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    delete:
      tags:
        - vpn
      summary: Delete OpenVPN server
      description: ""
      operationId: DeleteOpenVPNServer
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /vpn/openvpn/status:
    get:
      tags:
        - vpn
      summary: Get OpenVPN Status
      description: ""
      operationId: GetOpenVPNStatus
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OpenVPNStatus'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /vpn/wg:
    get:
      tags:
        - vpn
      summary: List WireGuard config
      description: ""
      operationId: GetWireGuard
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WireGuardSettings'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /vpn/wg/genkeys:
    get:
      tags:
        - vpn
      summary: Get a new pair of public/private keys
      description: ""
      operationId: GetNewWireGuardKeys
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WireGuardKeys'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /vpn/wg/peer:
    post:
      tags:
        - vpn
      summary: Set WireGuard Peer
      description: ""
      operationId: SetWireGuardPeer
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WGPeer'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /vpn/wg/peer/{id}:
    parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
    put:
      tags:
        - vpn
      summary: Update WireGuard Peer
      description: ""
      operationId: UpdateWireGuardPeer
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WGPeer'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    delete:
      tags:
        - vpn
      summary: Delete WireGuard Peer
      description: ""
      operationId: DeleteWireGuardPeer
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /vpn/wg/settings:
    post:
      tags:
        - vpn
      summary: Set WireGuard Settings
      description: ""
      operationId: SetWireGuardSettings
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WGConfig'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /vpn/wg/status:
    get:
      tags:
        - vpn
      summary: Get Wireguard status
      description: ""
      operationId: GetWireGuardStatus
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WireGuardStatus'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /vpn/wg/tunnel:
    post:
      tags:
        - vpn
      summary: Set WireGuard Tunnel
      description: ""
      operationId: SetWireGuardTunnel
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WGTunnel'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /vpn/wg/tunnel/{id}:
    parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
    put:
      tags:
        - vpn
      summary: Update WireGuard Tunnel
      description: ""
      operationId: UpdateWireGuardTunnel
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WGTunnel'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    delete:
      tags:
        - vpn
      summary: Delete WireGuard Tunnel
      description: ""
      operationId: DeleteWireGuardTunnel
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PfsenseResult'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /vpn/wg/tunnel/{id}/conf:
    parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
    get:
      tags:
        - vpn
      summary: Get Wireguard Tunnel Conf
      description: ""
      operationId: GetWireGuardTunnelConf
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WGTunnelConf'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Result:
      type: object
      properties:
        result:
          type: string
    Error:
      type: object
      properties:
        errcode:
          type: integer
          description: Error code
        errmsg:
          type: string
          description: Error message
        alerts:
          $ref: '#/components/schemas/PfsenseResult'
    PfsenseResult:
      type: object
      properties:
        msg:
          type: string
        alrt:
          type: boolean
        sb:
          type: boolean
        alrtoln:
          type: boolean
        alrtclr:
          type: string
        auth:
          type: boolean
        status:
          type: string
        message:
          type: string
    SimpleInterface:
      type: object
      properties:
        text:
          type: string
        value:
          type: string
    LoginCredentials:
      type: object
      properties:
        username:
          type: string
        password:
          type: string
        secondfactor:
          type: string
    LoginResponse:
      type: object
      properties:
        token:
          type: string
        user:
          type: string
        version:
          type: string
    RefreshTokenParam:
      type: object
      properties:
        username:
          type: string
    AuthServersList:
      type: object
      properties:
        svrlist:
          type: array
          items:
            type: string
        authtype:
          type: string
    AuthTestCredentials:
      type: object
      properties:
        authtype:
          type: string
        username:
          type: string
        password:
          type: string
    AuthTestResult:
      type: object
      properties:
        authenticated:
          type: boolean
    ControllerSummary:
      type: object
      description: |
        Information provided to the remote device on how to connect to the
        controller using Netgard.
      properties:
        mode_active:
          type: boolean
        name:
          type: string
        key:
          type: string
        vpn_pubkey:
          type: string
        vpn_listenaddr:
          type: string
        vpn_address:
          type: string
        vpn_prefix:
          type: string
        vpn_netkey:
          type: string
        vpn_listenaddr4:
          type: string
        vpn_listenaddr6:
          type: string
    ControllerIdentity:
      type: object
      properties:
        name:
          type: string
        key:
          type: string
        cert:
          type: string
        vpn_listenaddr:
          type: string
        vpn_address:
          type: string
        vpn_pubkey:
          type: string
        vpn_netkey:
          type: string
        vpn_prefix:
          type: string
        oldkey:
          type: string
        regentokens:
          type: boolean
        vpn_listenaddr4:
          type: string
        vpn_listenaddr6:
          type: string
    DeviceVpn:
      type: object
      description: The device's VPN settings
      properties:
        vpn_listenaddr:
          type: string
        vpn_address:
          type: string
        vpn_pubkey:
          type: string
        vpn_netkey:
          type: string
        vpn_prefix:
          type: string
        vpn_state:
          type: string
        vpn_conn_start:
          type: integer
        vpn_conn_stop:
          type: integer
        vpn_conn_attempt:
          type: integer
        vpn_listenaddr4:
          type: string
        vpn_listenaddr6:
          type: string
    ControllerInfo:
      type: object
      properties:
        name:
          type: string
        key:
          type: string
        cert:
          type: string
        vpn_listenaddr:
          type: string
        vpn_address:
          type: string
        vpn_pubkey:
          type: string
        vpn_netkey:
          type: string
        vpn_prefix:
          type: string
        tag:
          type: string
        noise_secret:
          type: string
        device_pubkey:
          type: string
        device_vpn:
          $ref: '#/components/schemas/DeviceVpn'
    ControllersList:
      type: object
      properties:
        device_pubkey:
          type: string
        controllers:
          type: array
          items:
            $ref: '#/components/schemas/ControllerInfo'
    DeviceIdentity:
      type: object
      description: |
        Fields:
        * name:            name of device
        * alias:           another alias for the device
        * type:            device type
        * pubkey:          public key identity of device
        * address:         device's API URL, e.g. https://0.0.0.0:8443
        * vpn_pubkey:      VPN public key
        * vpn_address:     Netgard VPN address
        * vpn_prefix:      Netgard VPN address subnet
        * vpn_netkey:      Netgard VPN netkey
        * vpn_listenaddr:  Netgard listening address:port
        * devinfo:         summary of device information
        * tags:            Optional tags assigned to device
        
        * controller_add:  curl command that can be used to add the device to the controller.
      properties:
        name:
          type: string
        alias:
          type: string
        type:
          type: string
        pubkey:
          type: string
        address:
          type: string
        vpn_pubkey:
          type: string
        vpn_address:
          type: string
        vpn_prefix:
          type: string
        vpn_netkey:
          type: string
        vpn_listenaddr:
          type: string
        controller_add:
          type: string
        devinfo:
          $ref: '#/components/schemas/ControlledDeviceInfo'
        tags:
          type: array
          items:
            type: string
        vpn_listenaddr4:
          type: string
        vpn_listenaddr6:
          type: string
    DevicePublicKeyOption:
      type: object
      properties:
        keytype:
          type: string
        privkey:
          type: string
        pubkey:
          type: string
    ControlledDeviceCerts:
      type: object
      properties:
        certs:
          type: array
          items:
            $ref: '#/components/schemas/ControlledDeviceCert'
    ControlledDeviceCert:
      type: object
      properties:
        name:
          type: string
        key:
          type: string
        cert:
          type: string
        ca_cert:
          type: string
    ControlledDeviceCertOptions:
      type: object
      properties:
        organization:
          type: string
        country:
          type: string
        province:
          type: string
        locality:
          type: string
        street_addr:
          type: string
        postal_code:
          type: string
        ip_addresses:
          type: array
          items:
            type: string
        expiry_days:
          type: integer
    CreateControlledDeviceCert:
      type: object
      properties:
        name:
          type: string
        key:
          type: string
        cert:
          type: string
        ca_cert:
          type: string
        options:
          $ref: '#/components/schemas/ControlledDeviceCertOptions'
    ControlledDeviceAuth:
      type: object
      properties:
        vpn_pubkey:
          type: string
        vpn_address:
          type: string
        vpn_listenaddr:
          type: string
        cert:
          type: string
        vpn_listenaddr4:
          type: string
        vpn_listenaddr6:
          type: string
    ControlledDevice:
      type: object
      description: Parameters for adding the device
      properties:
        name:
          type: string
        alias:
          type: string
        device_id:
          type: string
        device_type:
          type: string
        tags:
          type: array
          items:
            type: string
        address:
          type: string
        address6:
          type: string
        primary_auth:
          type: string
        auth:
          $ref: '#/components/schemas/ControlledDeviceAuth'
        state:
          type: string
        device_cert:
          type: string
        device_key:
          type: string
        device_info:
          $ref: '#/components/schemas/ControlledDeviceInfo'
    DeviceServiceBasic:
      type: object
      properties:
        type:
          type: string
        name:
          type: string
        enabled:
          type: boolean
    ControlledDeviceInfo:
      type: object
      description: Additional information about the device
      properties:
        hostname:
          type: string
        uptime:
          type: integer
        network_ports:
          type: array
          items:
            $ref: '#/components/schemas/DeviceNetworkPort'
        services:
          type: array
          items:
            $ref: '#/components/schemas/DeviceServiceBasic'
        product:
          type: string
        product_version:
          type: string
        product_build:
          type: string
        os_name:
          type: string
        os_version:
          type: string
        cpu:
          type: string
        memory:
          type: integer
        model:
          type: string
        vendor:
          type: string
        serial:
          type: string
        hw_uuid:
          type: string
    ControlledDeviceDetailed:
      type: object
      description: Detailed information about the controlled device
      properties:
        name:
          type: string
        alias:
          type: string
        device_id:
          type: string
        device_type:
          type: string
        tags:
          type: array
          items:
            type: string
        address:
          type: string
        address6:
          type: string
        primary_auth:
          type: string
        auth:
          $ref: '#/components/schemas/ControlledDeviceAuth'
        state:
          type: string
        device_cert:
          type: string
        device_key:
          type: string
        sys_info:
          $ref: '#/components/schemas/ControlledDeviceInfo'
    ControlledDevices:
      type: object
      properties:
        devices:
          type: array
          items:
            $ref: '#/components/schemas/ControlledDeviceDetailed'
    DeviceTagOption:
      type: object
      properties:
        tags:
          type: array
          items:
            type: string
        devices:
          type: array
          items:
            type: string
        action:
          type: string
    DeleteControlledDeviceCertRequest:
      type: object
      properties:
        name:
          type: string
    MeshVpnConns:
      type: object
      properties:
        vpn_type:
          type: string
        vpn_name:
          type: string
        subnets:
          type: array
          items:
            type: string
        conns:
          type: string
    MeshStats:
      type: object
      properties:
        devices_total:
          type: integer
        devices_online:
          type: integer
        vpn_conns:
          type: array
          items:
            $ref: '#/components/schemas/MeshVpnConns'
    StorageStats:
      type: object
      properties:
        volume:
          type: string
        device:
          type: string
        capacity:
          type: integer
        used:
          type: integer
    ControllerStats:
      type: object
      properties:
        uptime:
          type: integer
        started:
          type: integer
        mem_total:
          type: integer
        mem_used:
          type: integer
        storage:
          type: array
          items:
            $ref: '#/components/schemas/StorageStats'
        cpu_load:
          type: array
          items:
            type: integer
        admin_logins:
          type: integer
        systems_total:
          type: integer
        systems_online:
          type: integer
        systems_failed:
          type: integer
        mesh:
          $ref: '#/components/schemas/MeshStats'
    ControllerService:
      type: object
      properties:
        listening:
          type: array
          items:
            type: string
        config:
          type: object
          additionalProperties:
            type: string
        license:
          type: string
    ControllerDescrip:
      type: object
      properties:
        build:
          type: string
        api_version:
          type: string
        host:
          type: string
        host_os:
          type: object
          additionalProperties:
            type: string
        pubkey:
          type: string
        tls_pubkey:
          type: string
        tls_key_id:
          type: string
        public_addresses:
          type: array
          items:
            type: string
        stats:
          $ref: '#/components/schemas/ControllerStats'
    ControllerServiceAction:
      type: object
      properties:
        action:
          type: string
          description: Action to carry out [restart, reload, stop]
    LogEntry:
      type: object
      properties:
        type:
          type: string
        timestamp:
          type: integer
        device_name:
          type: string
        device_address:
          type: string
        class:
          type: string
        message:
          type: string
          format: byte
    LogEntries:
      type: object
      properties:
        entries:
          type: array
          items:
            $ref: '#/components/schemas/LogEntry'
    ControllerAlarm:
      type: object
      properties:
        count:
          type: integer
        messages:
          type: array
          items:
            type: string
    ControllerAlarms:
      type: object
      properties:
        alarms:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/ControllerAlarm'
    DeviceBasicInfo:
      type: object
      properties:
        name:
          type: string
        device_id:
          type: string
        device_type:
          type: string
        os_type:
          type: string
        os_version:
          type: string
        address:
          type: string
    AllSoftwarePackages:
      type: object
      description: |
        Example:
        
        {
          "software_packages": {
            "plus": {
              "24.03": {
                "packages": [
                  { "name": "snort", "category": "security", "local_version": "1.0.1", "avail_version": "1.0.2" },
                  ...
                ]
              }
            },
            "free": {
              "2.8.0": {
                "packages": [
                  { "name": "tinyproxy", "category": "net", "local_version": "1.1", "avail_version": "1.1" },
                  ...
                ]
              }
            }
          }
        }
      properties:
        software_packages:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/OSSoftwarePackages'
    OSSoftwarePackages:
      type: object
      additionalProperties:
        $ref: '#/components/schemas/SoftwarePackageList'
    SoftwarePackageList:
      type: object
      properties:
        packages:
          type: array
          items:
            $ref: '#/components/schemas/SoftwarePackage'
    SoftwarePackage:
      type: object
      properties:
        name:
          type: string
        id:
          type: string
        category:
          type: string
        description:
          type: string
        local_version:
          type: string
        avail_version:
          type: string
        dependencies:
          type: array
          items:
            type: string
        filename:
          type: string
        checksum:
          type: string
        os_type:
          type: string
        os_version:
          type: string
        installed_on:
          type: array
          items:
            $ref: '#/components/schemas/DeviceBasicInfo'
    DevicePkgInstallRequest:
      type: object
      properties:
        device_ids:
          type: array
          items:
            type: string
    DevicePkgInstallResult:
      type: object
      properties:
        device_id:
          type: string
        previous_version:
          type: string
        active_version:
          type: string
        install_messages:
          type: string
          format: byte
        result:
          type: string
    DevicePkgInstallResults:
      type: object
      properties:
        devices:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/DevicePkgInstallResult'
    InstallSoftwarePackageInfo:
      type: object
      properties:
        package:
          $ref: '#/components/schemas/SoftwarePackage'
        installable:
          type: array
          items:
            $ref: '#/components/schemas/DeviceBasicInfo'
    DevicePkgUninstallResult:
      type: object
      properties:
        device_id:
          type: string
        uninstall_messages:
          type: string
          format: byte
        result:
          type: string
    DevicePkgUninstallResults:
      type: object
      properties:
        devices:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/DevicePkgUninstallResult'
    ControllerUpgradeInfo:
      type: object
      properties:
        current_version:
          type: string
        new_version:
          type: string
        changes:
          type: string
          format: byte
    ControllerUpgradeRequest:
      type: object
      properties:
        version:
          type: string
        restart:
          type: boolean
    ControllerUpgradeResult:
      type: object
      properties:
        active_version:
          type: string
        previous_version:
          type: string
        restart_time:
          type: integer
        messages:
          type: string
          format: byte
    ControllerBackup:
      type: object
      properties:
        time:
          type: integer
        id:
          type: string
        label:
          type: string
        description:
          type: string
        acb_id:
          type: string
          format: byte
    ControllerBackups:
      type: object
      properties:
        backups:
          type: array
          items:
            $ref: '#/components/schemas/ControllerBackup'
    ControllerBackupRequest:
      type: object
      properties:
        label:
          type: string
        description:
          type: string
        auto_backup:
          type: boolean
        acb_password:
          type: string
    ControllerBackupResult:
      type: object
      properties:
        time:
          type: integer
        id:
          type: string
        label:
          type: string
        description:
          type: string
        acb_id:
          type: string
          format: byte
        messages:
          type: string
          format: byte
    ControllerBackupRestoreRequest:
      type: object
      properties:
        reason:
          type: string
    ControllerBackupRestoreResult:
      type: object
      properties:
        messages:
          type: string
          format: byte
    Event:
      type: object
      properties:
        event_type:
          type: string
        event_id:
          type: integer
          description: ID is microsecond timestamp
        firewall:
          $ref: '#/components/schemas/FirewallEvent'
        interface:
          $ref: '#/components/schemas/InterfaceEvent'
        system:
          $ref: '#/components/schemas/SystemEvent'
    InterfaceEvent:
      type: object
      properties:
        name:
          type: string
          description: name of interface device
        friendly_name:
          type: string
          description: friendly name eg wan, lan
        state:
          type: string
          description: current state change
        speed:
          type: integer
          description: speed change, Mbps
    FirewallEvent:
      type: object
      properties:
        intf_name:
          type: string
          description: friendly network interface name
        action:
          type: string
          description: activity on the rule - added, updated, deleted, moved
        rule_type:
          type: string
          description: filter, separator, nat, nat1to1, natout, npt
        filter:
          $ref: '#/components/schemas/FWFilterRule'
        nat:
          $ref: '#/components/schemas/NATRule'
        nat1to1:
          $ref: '#/components/schemas/NAT1To1Rule'
        natout:
          $ref: '#/components/schemas/NATOutboundRule'
        npt:
          $ref: '#/components/schemas/NATNptRule'
        separator:
          $ref: '#/components/schemas/Separator'
    SystemEvent:
      type: object
      description: changes to the system that is informational or impacts operation
      properties:
        message:
          type: string
          description: message to show to the user
        level:
          type: string
          description: debug, info, warning, error
    Events:
      type: object
      properties:
        events:
          type: array
          items:
            $ref: '#/components/schemas/Event'
    SysinfoFs:
      type: object
      properties:
        path:
          type: string
        fs_name:
          type: string
        fs_type:
          type: string
        total:
          type: integer
        used:
          type: integer
    SysNetIf:
      type: object
      description: network interface on the device
      properties:
        name:
          type: string
        identity:
          type: string
        device:
          type: string
        assigned:
          type: string
        link_speed:
          type: integer
        phy_speed:
          type: integer
        state:
          type: string
        vlan:
          type: integer
        device_info:
          type: string
        is_physical:
          type: boolean
        addresses:
          type: array
          items:
            type: string
        label:
          type: string
    Sysinfo:
      type: object
      properties:
        hostname:
          type: string
        address:
          type: array
          items:
            type: string
        serial:
          type: string
        version:
          type: string
        device_id:
          type: string
        crypto_id:
          type: string
        product:
          type: string
        product_version:
          type: string
        product_build:
          type: string
        os_name:
          type: string
        os_version:
          type: string
        bios_vendor:
          type: string
        bios_type:
          type: string
        bios_date:
          type: string
        bios_version:
          type: string
        cpu_model:
          type: string
        cpu_cores:
          type: integer
        cpu_features:
          type: string
        cpu_load:
          type: integer
        uptime:
          type: integer
        time:
          type: string
        mem_total:
          type: integer
        mem_used:
          type: integer
        loadavg:
          type: array
          items:
            type: integer
        vendor:
          type: string
        model:
          type: string
        hw_uuid:
          type: string
        filesystems:
          type: array
          items:
            $ref: '#/components/schemas/SysinfoFs'
        network_ports:
          type: array
          items:
            $ref: '#/components/schemas/SysNetIf'
        services:
          type: array
          items:
            $ref: '#/components/schemas/DeviceServiceBasic'
    SysinfoUpdate:
      type: object
      properties:
        hostname:
          type: string
        time:
          type: string
    LoadAvg:
      type: object
      properties:
        loadavg:
          type: array
          items:
            type: integer
    Disks:
      type: object
      properties:
        disks:
          type: array
          items:
            $ref: '#/components/schemas/SysinfoFs'
    HWDevice:
      type: object
      properties:
        name:
          type: string
        location:
          type: string
        type:
          type: string
        vendor:
          type: string
        class:
          type: string
    HWDevices:
      type: object
      properties:
        devices:
          type: array
          items:
            $ref: '#/components/schemas/HWDevice'
    MemoryMap:
      type: object
      properties:
        offset:
          type: integer
        size:
          type: integer
        type:
          type: string
    Dimm:
      type: object
      properties:
        slot:
          type: string
        size:
          type: integer
        type:
          type: string
    MemoryStat:
      type: object
      properties:
        total:
          type: integer
        reserved:
          type: integer
        used:
          type: integer
    Memory:
      type: object
      properties:
        memory_map:
          type: array
          items:
            $ref: '#/components/schemas/MemoryMap'
        dimms:
          type: array
          items:
            $ref: '#/components/schemas/Dimm'
        stats:
          $ref: '#/components/schemas/MemoryStat'
    SystemSummary:
      type: object
      properties:
        name:
          type: string
        os:
          type: string
        arch:
          type: string
        api_version:
          type: string
    DirtySubsystem:
      type: object
      properties:
        name:
          type: string
        descr:
          type: string
        file:
          type: string
    DirtySubsystems:
      type: object
      properties:
        dirty_subsystems:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/DirtySubsystem'
        all_subsystems:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/DirtySubsystem'
    ApplyDirtyConfigRequest:
      type: object
      properties:
        apply:
          type: boolean
    Bootenv:
      type: object
      properties:
        creation_nice:
          type: string
        used_nice:
          type: integer
        version:
          type: string
        name:
          type: string
        mounted:
          type: string
        activate_title:
          type: string
        dataset:
          type: string
        prior:
          type: string
        creation:
          type: string
        usedrefreserv:
          type: string
        used:
          type: string
        upgrading:
          type: boolean
        active:
          type: boolean
        nextboot:
          type: boolean
        activate_icon:
          type: string
        lastbooted_nice:
          type: string
        usedsnap:
          type: string
        descr:
          type: string
        failed:
          type: boolean
        referenced:
          type: string
        mountpoint:
          type: string
        bootonce:
          type: boolean
        origin:
          type: string
        useds:
          type: string
        protect:
          type: boolean
    ActivateBootenv:
      type: object
      properties:
        name:
          type: string
        temp:
          type: boolean
    DeleteBootenvs:
      type: object
      properties:
        names:
          type: array
          items:
            type: string
        name:
          type: string
    CreateBootenv:
      type: object
      properties:
        name:
          type: string
        descr:
          type: string
        from:
          type: string
        protect:
          type: boolean
    UpdateBootenv:
      type: object
      properties:
        old_name:
          type: string
        name:
          type: string
        descr:
          type: string
        protect:
          type: boolean
    QuickResult:
      type: object
      properties:
        name:
          type: string
    BootEnvs:
      type: object
      properties:
        envs:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/Bootenv'
    TLSCertPath:
      type: object
      properties:
        cert_path:
          type: string
        key_path:
          type: string
    SystemAdvAdmin:
      type: object
      properties:
        webguiproto:
          type: string
        webguiport:
          type: string
        max_procs:
          type: integer
        disablehttpredirect:
          type: boolean
        disablehsts:
          type: boolean
        ocsp_staple:
          type: boolean
        disableconsolemenu:
          type: boolean
        noantilockout:
          type: boolean
        nodnsrebindcheck:
          type: boolean
        nohttpreferercheck:
          type: boolean
        pagenamefirst:
          type: boolean
        loginautocomplete:
          type: boolean
        althostnames:
          type: string
        enableserial:
          type: boolean
        serialspeed:
          type: string
        primaryconsole:
          type: string
        sshport:
          type: string
        enablesshd:
          type: boolean
        sshdkeyonly:
          type: string
        sshdagentforwarding:
          type: boolean
        quietlogin:
          type: boolean
        roaming:
          type: boolean
        sshguard_threshold:
          type: string
        sshguard_blocktime:
          type: string
        sshguard_detection_time:
          type: string
        sshguard_whitelist:
          type: string
        ssl_certref:
          type: string
        certsavailable:
          type: boolean
        certlist:
          type: array
          items:
            $ref: '#/components/schemas/SystemCert'
    SystemCert:
      type: object
      properties:
        id:
          type: string
        descr:
          type: string
    SystemAdvAdminSetting:
      type: object
      properties:
        admin:
          $ref: '#/components/schemas/SystemAdvAdmin'
    AdvFirewall:
      type: object
      properties:
        adaptiveend:
          type: string
        adaptivestart:
          type: string
        aliasesresolveinterval:
          type: string
        bogonsinterval:
          type: string
        bypassstaticroutes:
          type: boolean
        checkaliasesurlcert:
          type: boolean
        disablefilter:
          type: boolean
        disablenatreflection:
          type: boolean
        disablenegate:
          type: boolean
        disablereplyto:
          type: boolean
        disablescrub:
          type: boolean
        disablevpnrules:
          type: boolean
        enablebinatreflection:
          type: boolean
        enablenatreflectionhelper:
          type: boolean
        enablenatreflectionpurenat:
          type: boolean
        icmperrortimeout:
          type: string
        icmpfirsttimeout:
          type: string
        maximumfrags:
          type: string
        maximumstates:
          type: string
        maximumtableentries:
          type: string
        maxmss:
          type: string
        maxmss_enable:
          type: boolean
        vpn_scrubenodf:
          type: boolean
        vpn_fragment_reassemble:
          type: boolean
        natreflection:
          type: string
        no_apipa_block:
          type: boolean
        optimization:
          type: string
        otherfirsttimeout:
          type: string
        othermultipletimeout:
          type: string
        othersingletimeout:
          type: string
        reflectiontimeout:
          type: string
        scrubnodf:
          type: boolean
        scrubrnid:
          type: boolean
        sctpfirsttimeout:
          type: string
        sctpopeningtimeout:
          type: string
        sctpestablishedtimeout:
          type: string
        sctpclosingtimeout:
          type: string
        sctpclosedtimeout:
          type: string
        tcpclosedtimeout:
          type: string
        tcpclosingtimeout:
          type: string
        tcpestablishedtimeout:
          type: string
        tcpfinwaittimeout:
          type: string
        tcpfirsttimeout:
          type: string
        tcpopeningtimeout:
          type: string
        tcptsdifftimeout:
          type: string
        tftpinterface:
          type: array
          items:
            type: string
        udpfirsttimeout:
          type: string
        udpmultipletimeout:
          type: string
        udpsingletimeout:
          type: string
    AdvFirewallSetting:
      type: object
      properties:
        firewall:
          $ref: '#/components/schemas/AdvFirewall'
        interfaces:
          type: array
          items:
            $ref: '#/components/schemas/SimpleInterface'
    AdvMiscSetting:
      type: object
      properties:
        misc:
          $ref: '#/components/schemas/AdvMisc'
    AdvMisc:
      type: object
      properties:
        available_kernel_memory:
          type: integer
        block_external_services:
          type: boolean
        crypto_hardware:
          type: string
        do_not_send_uniqueid:
          type: boolean
        dpinger_dont_add_static_routes:
          type: boolean
        gw_down_kill_states:
          type: boolean
        harddiskstandby:
          type: string
        hwpstate:
          type: boolean
        hwpstate_control_level:
          type: string
        hwpstate_epp:
          type: integer
        ipsec_mb:
          type: boolean
        keep_failover_states:
          type: boolean
        lb_use_sticky:
          type: boolean
        mds:
          type: string
        mds_disable:
          type: string
        php_memory_limit:
          type: integer
        powerd_ac_mode:
          type: string
        powerd_battery_mode:
          type: string
        powerd_enable:
          type: boolean
        powerd_normal_mode:
          type: string
        proxypass:
          type: string
        proxypass_confirm:
          type: string
        proxyport:
          type: integer
        proxyurl:
          type: string
        proxyuser:
          type: string
        pti:
          type: string
        pti_disabled:
          type: boolean
        remove_failover_states_default:
          type: string
        schedule_states:
          type: boolean
        skip_rules_gw_down:
          type: boolean
        srctrack:
          type: string
        thermal_hardware:
          type: string
        use_mfs_tmp_size:
          type: integer
        use_mfs_tmpvar:
          type: boolean
        use_mfs_var_size:
          type: integer
        watchdogd_enable:
          type: boolean
        watchdogd_timeout:
          type: string
    AdvNetworking:
      type: object
      properties:
        networking:
          $ref: '#/components/schemas/AdvNetworkSetting'
    AdvNetworkSetting:
      type: object
      properties:
        disablechecksumoffloading:
          type: boolean
        disablesegmentationoffloading:
          type: boolean
        disablelargereceiveoffloading:
          type: boolean
        dhcp6debug:
          type: boolean
        dhcp6norelease:
          type: boolean
        hnaltqenable:
          type: boolean
        ignoreiscwarning:
          type: boolean
        ip_change_kill_states:
          type: boolean
        ipv6allow:
          type: boolean
        ipv6dontcreatelocaldns:
          type: boolean
        ipv6nat_enable:
          type: boolean
        prefer_ipv4:
          type: boolean
        sharednet:
          type: boolean
        duid:
          type: string
        global_v6duid:
          type: string
        ipv6duiden_en:
          type: string
        ipv6duiden_id:
          type: string
        ipv6duidll:
          type: string
        ipv6duidllt_ll:
          type: string
        ipv6duidllt_time:
          type: string
        ipv6duidtype:
          type: string
        ipv6duiduuid:
          type: string
        ipv6nat_ipaddr:
          type: string
        dhcpbackend:
          type: string
    AdvNotifications:
      type: object
      properties:
        notifications:
          $ref: '#/components/schemas/AdvNotificationSetting'
    AdvNotificationSetting:
      type: object
      properties:
        cert_enable_notify:
          type: boolean
        disablebeep:
          type: boolean
        disable_smtp:
          type: boolean
        enable_pushover:
          type: boolean
        enable_telegram:
          type: boolean
        smtpssl:
          type: boolean
        sslvalidate:
          type: boolean
        api:
          type: string
        certexpiredays:
          type: integer
        chatid:
          type: string
        pushoverapikey:
          type: string
        pushoverexpire:
          type: integer
        pushoverpriority:
          type: string
        pushoverretry:
          type: integer
        pushoversound:
          type: string
        pushoveruserkey:
          type: string
        smtpauthmech:
          type: string
        smtpfromaddress:
          type: string
        smtpipaddress:
          type: string
        smtpnotifyemailaddress:
          type: string
        smtppassword:
          type: string
        smtppassword_confirm:
          type: string
        smtpport:
          type: string
        smtptimeout:
          type: integer
        smtpusername:
          type: string
        save:
          type: boolean
        test_smtp:
          type: boolean
        test_telegram:
          type: boolean
        test_pushover:
          type: boolean
        revoked_cert_ignore_notify:
          type: boolean
        enable_slack:
          type: boolean
        slack_api:
          type: string
        slack_channel:
          type: string
    Tunables:
      type: object
      properties:
        tunables:
          type: array
          items:
            $ref: '#/components/schemas/Tunable'
    Tunable:
      type: object
      properties:
        tunable:
          type: string
        value:
          type: string
        descr:
          type: string
        modified:
          type: boolean
    TunableRequest:
      type: object
      properties:
        tunable:
          $ref: '#/components/schemas/Tunable'
        id:
          type: integer
    CertsConfig:
      type: object
      properties:
        certs:
          type: array
          items:
            $ref: '#/components/schemas/CertificateDetailed'
    CertConfig:
      type: object
      properties:
        cert:
          $ref: '#/components/schemas/CertificateDetailed'
    CertificateDetailed:
      type: object
      properties:
        refid:
          type: string
        descr:
          type: string
        crt:
          type: string
        csr:
          type: string
        caref:
          type: string
        cadata:
          type: string
        ends:
          type: string
        inuse:
          type: string
        issuer:
          type: string
        prv:
          type: string
        starts:
          type: string
        subj:
          type: string
        type:
          type: string
        name:
          type: string
        dn:
          type: string
        info:
          $ref: '#/components/schemas/CertInfo'
        can_renew:
          type: boolean
    NewCertReq:
      type: object
      description: |
        Request for creating a cert or updating an existing one.
        - name: short description about certificate
        - userid: user-ID for user-specific certificate, eg for VPN
        - description:  Descriptive name
        - one of the method_xxxx
      properties:
        name:
          type: string
        descr:
          type: string
        description:
          type: string
        userid:
          type: integer
        method_internal:
          $ref: '#/components/schemas/CertMethodNew'
        method_existing_pem:
          $ref: '#/components/schemas/CertMethodExistingPEM'
        method_existing_pkcs12:
          $ref: '#/components/schemas/CertMethodExistingPkcs12'
        method_csr:
          $ref: '#/components/schemas/CertMethodSigningRequest'
        method_sign:
          $ref: '#/components/schemas/CertMethodSignCSR'
    UpdateCertReq:
      type: object
      description: |
        Update the certificate using either PEM or PKCS12 data. This operation is similar to
        importing a new certificate.
      properties:
        name:
          type: string
        descr:
          type: string
        description:
          type: string
        method_existing_pem:
          $ref: '#/components/schemas/CertMethodExistingPEM'
        method_existing_pkcs12:
          $ref: '#/components/schemas/CertMethodExistingPkcs12'
    UpdatePKCS12CertReq:
      type: object
      description: Update the certificate with PKCS12 appended file upload
      properties:
        name:
          type: string
        descr:
          type: string
        description:
          type: string
        method_existing_pkcs12:
          $ref: '#/components/schemas/CertMethodExistingPkcs12'
    CertMethodNew:
      type: object
      description: |
        Options for creating/updating an internal certificate.
        For key type, size and options, query /system/certopts for the
        supported values.
        
        - caref:        CA (refid) to sign cert
        - key_type:     RSA or ECDSA
        - key_size:     size of key in bits (RSA)
        - key_opt:      curve types (historically ecname)
        - digest_alg:   hash algorithm for signing
        - lifetime:     days to expire
        - cn:           common name
        - country_code: 2-character country code
        - state:        state or province
        - city:         city
        - org:          organization, business name
        - ou:           organization unit
        - server_cert   true for server cert, false for user cert
      properties:
        caref:
          type: string
        key_type:
          type: string
        key_size:
          type: integer
        key_opt:
          type: string
        digest_alg:
          type: string
        lifetime:
          type: integer
        cn:
          type: string
        country_code:
          type: string
        state:
          type: string
        city:
          type: string
        org:
          type: string
        ou:
          type: string
        server_cert:
          type: boolean
        alt_names:
          type: array
          items:
            $ref: '#/components/schemas/CertAltName'
    CertAltName:
      type: object
      description: |
        Alternative name specifies a type and a value:
        - type:    fqdn, ip, uri, or email
        - value:   string that applies to the type
      properties:
        type:
          type: string
        value:
          type: string
    CertMethodExistingPEM:
      type: object
      description: Existing PEM certificate and key, either in PEM/pkcs12 format or base64-encoded
      properties:
        cert:
          type: string
        private_key:
          type: string
    CertMethodExistingPkcs12:
      type: object
      description: |
        Existing PKCS12 certificate and key; the PKCS12 payload
        is to be sent as a file upload part in a multi-part request, otherwise
        it can be included as pkcs12_b64 directly within this structure.
      properties:
        password:
          type: string
        intermediates:
          type: boolean
        pkcs12_b64:
          type: string
    CertMethodSigningRequest:
      type: object
      properties:
        key_type:
          type: string
        key_size:
          type: integer
        key_opt:
          type: string
        digest_alg:
          type: string
        cn:
          type: string
        country_code:
          type: string
        state:
          type: string
        city:
          type: string
        org:
          type: string
        ou:
          type: string
        server_cert:
          type: boolean
        alt_names:
          type: array
          items:
            $ref: '#/components/schemas/CertAltName'
    CertMethodSignCSR:
      type: object
      description: |
        Sign a certificate signing request with the selected CA.
        An existing csr_refid or new CSR (base64 encoded "csr") must be provided.
      properties:
        caref:
          type: string
        csr_refid:
          type: string
        csr:
          type: string
        priv_key:
          type: string
        lifetime:
          type: integer
        digest_alg:
          type: string
        server_cert:
          type: boolean
        alt_names:
          type: array
          items:
            $ref: '#/components/schemas/CertAltName'
    CertInfo:
      type: object
      properties:
        issuer:
          type: string
        serial:
          type: string
        sig_digest:
          type: string
        key_usage:
          type: string
        key_type:
          type: string
        key_size:
          type: integer
        dn:
          type: string
        hash:
          type: string
        subject_key_id:
          type: string
        auth_key_id:
          type: string
        valid_from:
          type: string
        expires:
          type: string
        raw_data:
          type: string
        private_key:
          type: string
    CertAuthority:
      type: object
      properties:
        name:
          type: string
        refid:
          type: string
        internal:
          type: boolean
        issuer:
          type: string
        certificates:
          type: integer
        inuse:
          type: array
          items:
            type: string
        trust:
          type: boolean
        randomize_serial:
          type: boolean
        next_serial:
          type: integer
        info:
          $ref: '#/components/schemas/CertInfo'
    CertAuthorities:
      type: object
      properties:
        cas:
          type: array
          items:
            $ref: '#/components/schemas/CertAuthority'
    NewCaCertReq:
      type: object
      description: |
        Request for creating a new CA cert or updating an existing one.
        - name: short description about certificate
        - trust: add to OS trusted cert store
        - randomize_serial: use random serial numbers when signing certificates
        - one of: method_internal (self-signed), mehod_existing (import), or method_intermediate (signed by another CA)
      properties:
        name:
          type: string
        trust:
          type: boolean
        randomize_serial:
          type: boolean
        method_internal:
          $ref: '#/components/schemas/CaCertMethodNew'
        method_existing:
          $ref: '#/components/schemas/CaCertMethodExisting'
        method_intermediate:
          $ref: '#/components/schemas/CaCertMethodNew'
    CaCertMethodNew:
      type: object
      description: |
        Options for creating/updating an internal CA certificate.
        The values for internal and intermediate certificates are the same,
        with the exception that the intermediate certificate is signed by
        a CA referenced by caref.
        For key type, size and options, query /system/certopts for the
        supported values.
        
        - key_type:     RSA or ECDSA
        - key_size:     size of key in bits (RSA)
        - key_opt:      curve types (historically ecname)
        - digest_alg:   hash algorithm for signing
        - lifetime:     days to expire
        - cn:           common name
        - country_code: 2-character country code
        - state:        state or province
        - city:         city
        - org:          organization, business name
        - ou:           organization unit
        - caref:        signing CA reference ID
      properties:
        key_type:
          type: string
        key_size:
          type: integer
        key_opt:
          type: string
        digest_alg:
          type: string
        lifetime:
          type: integer
        cn:
          type: string
        country_code:
          type: string
        state:
          type: string
        city:
          type: string
        org:
          type: string
        ou:
          type: string
        caref:
          type: string
    CaCertMethodExisting:
      type: object
      description: Existing PEM certificate and key, either in PEM format or base64-encoded
      properties:
        cert:
          type: string
        private_key:
          type: string
        next_serial:
          type: integer
    RenewCertOptions:
      type: object
      description: Options for certificate renewal
      properties:
        reusekey:
          type: boolean
        reuseserial:
          type: boolean
        strictsecurity:
          type: boolean
    CertOpts:
      type: object
      properties:
        key_type:
          type: array
          items:
            type: string
        key_size:
          type: array
          items:
            type: integer
        key_opt:
          type: array
          items:
            type: string
        digest:
          type: array
          items:
            type: string
    CRLConfig:
      type: object
      properties:
        refid:
          type: string
        ca_refid:
          type: string
        descr:
          type: string
        method:
          type: string
        serial:
          type: integer
        lifetime:
          type: integer
        cert:
          type: string
        text:
          type: string
        internal:
          type: boolean
        inuse:
          type: boolean
        is_ovpn_crl:
          type: boolean
        pkgs:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/CRLPackageInfo'
    CRLPackageInfo:
      type: object
      properties:
        used_by:
          type: array
          items:
            type: string
        count:
          type: integer
    CRLEntries:
      type: object
      properties:
        crls:
          type: array
          items:
            $ref: '#/components/schemas/CRLConfig'
    FilterReloadStatus:
      type: object
      properties:
        ongoing:
          type: boolean
        done:
          type: boolean
        status_lines:
          type: array
          items:
            type: string
    GatewayDefaults:
      type: object
      properties:
        defaultgw4:
          type: string
        defaultgw6:
          type: string
    Gateway:
      type: object
      properties:
        name:
          type: string
        dynamic:
          type: boolean
        disabled:
          type: boolean
        ipprotocol:
          type: string
        gateway:
          type: string
        gw_down_kill_states:
          type: string
        interface:
          type: string
        friendlyiface:
          type: string
        friendlyifdescr:
          type: string
        action_disable:
          type: boolean
        attribute:
          type: string
        isdefaultgw:
          type: boolean
        monitor:
          type: string
        monitor_disable:
          type: boolean
        descr:
          type: string
        tiername:
          type: string
        weight:
          type: integer
        data_payload:
          type: integer
        interval:
          type: integer
        latencylow:
          type: integer
        latencyhigh:
          type: integer
        losslow:
          type: integer
        losshigh:
          type: integer
        loss_interval:
          type: integer
        time_period:
          type: integer
        alert_interval:
          type: integer
        nonlocalgateway:
          type: boolean
        defaults:
          $ref: '#/components/schemas/GatewayDefaults'
    Gateways:
      type: object
      properties:
        defaults:
          $ref: '#/components/schemas/GatewayDefaults'
        gateways:
          type: array
          items:
            $ref: '#/components/schemas/Gateway'
    GatewayVAddress:
      type: object
      properties:
        vaddress:
          type: string
        descr:
          type: string
    GatewayPInfo:
      type: object
      properties:
        name:
          type: string
        vaddress:
          type: array
          items:
            $ref: '#/components/schemas/GatewayVAddress'
        descr:
          type: string
    GatewayPriority:
      type: object
      properties:
        priority:
          type: string
        priority_descr:
          type: string
    GatewayPriorities:
      type: object
      properties:
        gateways:
          type: array
          items:
            $ref: '#/components/schemas/GatewayPInfo'
        priorities:
          type: array
          items:
            $ref: '#/components/schemas/GatewayPriority'
    GatewayGroupPriority:
      type: object
      properties:
        gateway:
          type: string
        priority:
          type: string
        vaddress:
          type: string
    GatewayGroup:
      type: object
      properties:
        idx:
          type: integer
        name:
          type: string
        descr:
          type: string
        gateway_priority:
          type: array
          items:
            $ref: '#/components/schemas/GatewayGroupPriority'
        keep_failover_states:
          type: string
        trigger:
          type: string
        trigger_descr:
          type: string
        keep_failover_states_descr:
          type: string
    GatewayGroups:
      type: object
      properties:
        groups:
          type: array
          items:
            $ref: '#/components/schemas/GatewayGroup'
    GatewaysStatus:
      type: object
      properties:
        gateways:
          type: array
          items:
            $ref: '#/components/schemas/GatewayStatus'
        groups:
          type: array
          items:
            $ref: '#/components/schemas/GroupStatus'
    GatewayStatus:
      type: object
      properties:
        name:
          type: string
        gateway:
          type: string
        monitor:
          type: string
        descr:
          type: string
        delay:
          type: string
        stddev:
          type: string
        loss:
          type: string
        status:
          type: string
        display:
          type: string
    GroupStatus:
      type: object
      properties:
        name:
          type: string
        descr:
          type: string
        tier1:
          type: array
          items:
            $ref: '#/components/schemas/Tier'
        tier2:
          type: array
          items:
            $ref: '#/components/schemas/Tier'
        tier3:
          type: array
          items:
            $ref: '#/components/schemas/Tier'
        tier4:
          type: array
          items:
            $ref: '#/components/schemas/Tier'
        tier5:
          type: array
          items:
            $ref: '#/components/schemas/Tier'
    Tier:
      type: object
      properties:
        name:
          type: string
        status:
          type: string
        display:
          type: string
    RoutesApplyRequest:
      type: object
      properties:
        apply:
          type: boolean
    RoutesDirtyState:
      type: object
      properties:
        dirty:
          type: boolean
    StaticRoute:
      type: object
      properties:
        network:
          type: string
        network_encoded:
          type: string
        gateway:
          type: string
        gateway_encoded:
          type: string
        descr:
          type: string
        disabled:
          type: boolean
        interface:
          type: string
    StaticRoutes:
      type: object
      properties:
        routes:
          type: array
          items:
            $ref: '#/components/schemas/StaticRoute'
    InterfaceInfoList:
      type: object
      properties:
        interfaces:
          type: array
          items:
            $ref: '#/components/schemas/InterfaceInfo'
    InterfaceInfo:
      type: object
      properties:
        assigned_interface:
          type: string
        internal_name:
          type: string
        friendly_name:
          type: string
        enabled:
          type: boolean
        status:
          type: string
        mac_address:
          type: string
        mtu:
          type: integer
        media:
          type: string
        plugged:
          type: string
        vendor:
          type: string
        temperature:
          type: string
        voltage:
          type: string
        rx:
          type: string
        tx:
          type: string
        channel:
          type: integer
        ssid:
          type: string
        bssid:
          type: string
        rate:
          type: string
        rssi:
          type: string
        in_packets:
          type: integer
        out_packets:
          type: integer
        in_bytes:
          type: integer
        out_bytes:
          type: integer
        in_packets_pass:
          type: integer
        out_packets_pass:
          type: integer
        in_bytes_pass:
          type: integer
        out_bytes_pass:
          type: integer
        in_packets_block:
          type: integer
        out_packets_block:
          type: integer
        in_bytes_block:
          type: integer
        out_bytes_block:
          type: integer
        in_errors:
          type: integer
        out_errors:
          type: integer
        collisions:
          type: integer
        ip_address:
          type: string
        subnet_mask:
          type: string
        gateway:
          type: string
        ipv6_link_local:
          type: string
        ipv6_address:
          type: string
        ipv6_subnet_mask:
          type: string
        ipv6_gateway:
          type: string
        dns_servers:
          type: array
          items:
            type: string
        lagg_enabled:
          type: boolean
        lagg_ports:
          type: string
        current_ppp_uptime:
          type: string
        historical_ppp_uptime:
          type: string
        cell_rssi:
          type: string
        cell_mode:
          type: string
        cell_simstate:
          type: string
        cell_service:
          type: string
        cell_bwupstream:
          type: integer
        cell_bwdownstream:
          type: integer
        cell_upstream:
          type: integer
        cell_downstream:
          type: integer
        dhcplink:
          type: string
        pppoelink:
          type: string
        pptplink:
          type: string
    QueueStats:
      type: object
      properties:
        name:
          type: string
        interface:
          type: string
        shapertype:
          type: string
        contains:
          type: array
          items:
            type: string
        pkts:
          type: string
        bytes:
          type: string
        droppedpkts:
          type: string
        droppedbytes:
          type: string
        qlengthitems:
          type: string
        qlengthsize:
          type: string
        borrows:
          type: string
        suspends:
          type: string
    TrafficQueueStats:
      type: object
      properties:
        timestamp:
          type: number
          format: double
        interfacestats:
          type: array
          items:
            $ref: '#/components/schemas/QueueStats'
    Package:
      type: object
      properties:
        name:
          type: string
        internal_name:
          type: string
        info_link:
          type: string
        descr:
          type: string
        version:
          type: string
        config_file:
          type: string
        include_file:
          type: string
        category:
          type: string
        depedencies:
          type: array
          items:
            type: string
    Packages:
      type: object
      properties:
        packages:
          type: array
          items:
            $ref: '#/components/schemas/Package'
    InstallPackageOpt:
      type: object
      properties:
        name:
          type: string
        version:
          type: string
    InstallPackagesOpt:
      type: object
      properties:
        packages:
          type: array
          items:
            $ref: '#/components/schemas/InstallPackageOpt'
    InstallPackagesResponse:
      type: object
      description: Current progress of package (re)installation. A transaction ID can be used to resume querying of status.
      properties:
        transaction:
          type: string
        progress:
          type: array
          items:
            $ref: '#/components/schemas/PackageInstallProgress'
    PackageInstallProgress:
      type: object
      properties:
        name:
          type: string
        version:
          type: string
        messages:
          type: array
          items:
            type: string
        percent:
          type: integer
        error:
          type: string
        action:
          type: string
    ServiceProviderSetting:
      type: object
      properties:
        name:
          type: string
        plans:
          type: array
          items:
            $ref: '#/components/schemas/ProviderPlanSetting'
    ProviderPlanSetting:
      type: object
      properties:
        name:
          type: string
        apn:
          type: string
        username:
          type: string
        password:
          type: string
        number:
          type: string
    ProviderCountrySetting:
      type: object
      properties:
        code:
          type: string
        provider:
          type: array
          items:
            $ref: '#/components/schemas/ServiceProviderSetting'
    ProviderCountry:
      type: object
      properties:
        country:
          $ref: '#/components/schemas/ProviderCountrySetting'
    ServiceProvider:
      type: object
      properties:
        provider:
          $ref: '#/components/schemas/ServiceProviderSetting'
    ServiceProviders:
      type: object
      properties:
        countries:
          type: array
          items:
            $ref: '#/components/schemas/ProviderCountrySetting'
    SetupDNSSetting:
      type: object
      properties:
        name:
          type: string
        ip:
          type: string
        gw:
          type: string
    SetupSettings:
      type: object
      properties:
        hostname:
          type: string
        domain:
          type: string
        timezone:
          type: integer
        timeservers:
          type: string
        disablefwd:
          type: boolean
        dnsoveride:
          type: boolean
        lang:
          type: string
        logincolor:
          type: string
        fixednav:
          type: boolean
        showhost:
          type: boolean
        dark:
          type: boolean
        loginmsg:
          type: string
        dnsservers:
          type: array
          items:
            $ref: '#/components/schemas/SetupDNSSetting'
    InitialSetup:
      type: object
      properties:
        setup:
          $ref: '#/components/schemas/SetupSettings'
    SetupWizard:
      type: object
      properties:
        setup:
          $ref: '#/components/schemas/SetupWizardOptions'
    SetupWizardOptions:
      type: object
      properties:
        hostname:
          type: string
        domain:
          type: string
        pridns:
          type: string
        secdns:
          type: string
        dnsovrd:
          type: boolean
        tz:
          type: string
        timesvrs:
          type: string
        wantype:
          type: string
        wanip:
          type: string
        gw:
          type: string
        spoofmac:
          type: string
        mtu:
          type: string
        mss:
          type: string
        dhcphost:
          type: string
        lanip:
          type: string
        bogons:
          type: boolean
        rfc1918:
          type: boolean
        pppoe:
          $ref: '#/components/schemas/SetupPPPoECfg'
    SetupPPPoECfg:
      type: object
      properties:
        username:
          type: string
        password:
          type: string
        dod:
          type: boolean
        idletimeout:
          type: string
        provider:
          type: string
        localip:
          type: string
    SystemUpdateInfo:
      type: object
      properties:
        firmware_branch:
          type: string
        firmware_branches:
          type: array
          items:
            $ref: '#/components/schemas/SystemUpdateFirmwareBranch'
        messages:
          type: array
          items:
            type: string
        boot_env:
          type: string
        curr_base_system:
          type: string
        latest_base_system:
          type: string
        status_message:
          type: string
        update_messages:
          type: array
          items:
            type: string
    SystemUpdateOptions:
      type: object
      properties:
        firmware_branch:
          type: string
    SystemUpdateFirmwareBranch:
      type: object
      properties:
        name:
          type: string
        descr:
          type: string
    SystemUpdateProgress:
      type: object
      properties:
        messages:
          type: array
          items:
            type: string
        completed:
          type: integer
        started_timestamp:
          type: integer
        ended_timestamp:
          type: integer
        started_time:
          type: string
        ended_time:
          type: string
    SystemUpdateSettings:
      type: object
      properties:
        firmware_branch:
          type: string
        firmware_branches:
          type: array
          items:
            $ref: '#/components/schemas/SystemUpdateFirmwareBranch'
        disable_check:
          type: boolean
        boot_envs:
          $ref: '#/components/schemas/SystemUpdateBootEnvsSettings'
        git_sync:
          $ref: '#/components/schemas/SystemGitSyncSettings'
    SystemUpdateSettingsSet:
      type: object
      properties:
        firmware_branch:
          type: string
        disable_check:
          type: boolean
        boot_envs:
          $ref: '#/components/schemas/SystemUpdateBootEnvsSettings'
    SystemUpdateBootEnvsSettings:
      type: object
      properties:
        deferred_boot:
          type: boolean
        verify:
          type: boolean
        verify_timeout:
          type: integer
    SystemGitSyncSettings:
      type: object
      properties:
        sync_on_upgrade:
          type: boolean
        repo_url:
          type: string
        branches:
          type: array
          items:
            type: string
        minimal:
          type: boolean
        diff:
          type: boolean
        show_files:
          type: boolean
        show_command:
          type: boolean
        dry_run:
          type: boolean
    UsersConfig:
      type: object
      properties:
        users:
          type: array
          items:
            $ref: '#/components/schemas/User'
        groups:
          type: array
          items:
            $ref: '#/components/schemas/UserGroup'
    Users:
      type: object
      properties:
        users:
          type: array
          items:
            $ref: '#/components/schemas/User'
    User:
      type: object
      properties:
        username:
          type: string
        name:
          type: string
        descr:
          type: string
        scope:
          type: string
        groupname:
          type: string
        groups:
          type: array
          items:
            type: string
        disabled:
          type: boolean
        uid:
          type: integer
        full_name:
          type: string
        cert_refids:
          type: array
          items:
            type: string
        authorized_keys:
          type: string
        privs:
          type: array
          items:
            type: string
        keep_cmd_history:
          type: boolean
        expiration:
          type: integer
        ipsec_psk:
          type: string
        custom_settings:
          type: boolean
        interfaces_sort:
          type: boolean
        webguicss:
          type: string
        webguifixedmenu:
          type: string
        webguihostnamemenu:
          type: string
        dashboardcolumns:
          type: integer
        dashboardavailablewidgetspanel:
          type: boolean
        systemlogsfilterpanel:
          type: boolean
        systemlogsmanagelogpanel:
          type: boolean
        statusmonitoringsettingspanel:
          type: boolean
        webguileftcolumnhyper:
          type: boolean
        disablealiaspopupdetail:
          type: boolean
        pagenamefirst:
          type: boolean
    UserGroups:
      type: object
      properties:
        groups:
          type: array
          items:
            $ref: '#/components/schemas/UserGroup'
    UserGroup:
      type: object
      properties:
        name:
          type: string
        description:
          type: string
        scope:
          type: string
        gid:
          type: integer
        member:
          type: array
          items:
            type: integer
    UserPrivilege:
      type: object
      properties:
        value:
          type: string
        text:
          type: string
        descr:
          type: string
        warn:
          type: string
    UserPrivileges:
      type: object
      properties:
        privs:
          type: array
          items:
            $ref: '#/components/schemas/UserPrivilege'
    UserAddReq:
      type: object
      properties:
        username:
          type: string
        password:
          type: string
        full_name:
          type: string
        groups:
          type: array
          items:
            type: string
        cert_refids:
          type: array
          items:
            type: string
        authorized_keys:
          type: string
          format: byte
        privs:
          type: array
          items:
            type: string
        keep_cmd_history:
          type: boolean
        expiration:
          type: integer
        disabled:
          type: boolean
        ipsec_psk:
          type: string
          format: byte
    UserUpdateReq:
      type: object
      properties:
        password:
          type: string
        full_name:
          type: string
        groups:
          type: array
          items:
            type: string
        cert_refids:
          type: array
          items:
            type: string
        authorized_keys:
          type: string
        ipsec_psk:
          type: string
          format: byte
        privs:
          type: array
          items:
            type: string
        keep_cmd_history:
          type: boolean
        expiration:
          type: integer
        disabled:
          type: boolean
    GroupAddReq:
      type: object
      properties:
        name:
          type: string
        description:
          type: string
        scope:
          type: string
        gid:
          type: integer
        members:
          type: array
          items:
            type: integer
    GroupUpdateReq:
      type: object
      properties:
        description:
          type: string
        scope:
          type: string
        gid:
          type: integer
        members:
          type: array
          items:
            type: integer
        remove_members:
          type: array
          items:
            type: integer
        privs:
          type: array
          items:
            type: string
    UserAuthSettings:
      type: object
      properties:
        session_timeout:
          type: integer
        authentication_server:
          type: string
        authentication_servers:
          type: array
          items:
            type: string
        password_hash:
          type: string
        password_hashes:
          type: array
          items:
            type: string
        shell_auth:
          type: boolean
        auth_refresh_time:
          type: integer
    UserAuthSettingsReq:
      type: object
      properties:
        authentication_server:
          type: string
        save_and_test:
          type: boolean
        session_timeout:
          type: integer
        password_hash:
          type: string
        shell_auth:
          type: boolean
        auth_refresh_time:
          type: integer
    RadiusAuthServer:
      type: object
      properties:
        type:
          type: string
        name:
          type: string
        host:
          type: string
        protocol:
          type: string
        nasip_attribute:
          type: string
        secret:
          type: string
        timeout:
          type: integer
        auth_port:
          type: integer
        acct_port:
          type: integer
        refid:
          type: string
    LdapAuthServer:
      type: object
      properties:
        type:
          type: string
        name:
          type: string
        host:
          type: string
        port:
          type: integer
        transport:
          type: string
        timeout:
          type: integer
        search_scope:
          type: string
        base_dn:
          type: string
        auth_containers:
          type: string
        extended_query:
          type: string
        bind_user_dn:
          type: string
        bind_password:
          type: string
        user_naming_attrib:
          type: string
        group_naming_attrib:
          type: string
        group_member_attrib:
          type: string
        rfc2307:
          type: boolean
        rfc2307_group_class:
          type: string
        rfc2307_use_userdn:
          type: boolean
        shell_group_dn:
          type: string
        username_alterations:
          type: boolean
        utf8_encode:
          type: boolean
        unauthenticated_bind:
          type: boolean
        caref:
          type: string
        certref:
          type: string
        refid:
          type: string
    LocalServer:
      type: object
      properties:
        name:
          type: string
        type:
          type: string
        host:
          type: string
    AuthServer:
      type: object
      properties:
        ldap:
          $ref: '#/components/schemas/LdapAuthServer'
        radius:
          $ref: '#/components/schemas/RadiusAuthServer'
    AuthServers:
      type: object
      properties:
        ldap:
          type: array
          items:
            $ref: '#/components/schemas/LdapAuthServer'
        radius:
          type: array
          items:
            $ref: '#/components/schemas/RadiusAuthServer'
        local:
          $ref: '#/components/schemas/LocalServer'
    MonitoringDataRequest:
      type: object
      properties:
        scope:
          type: string
        dataset:
          type: string
        start_time_unix_seconds:
          type: integer
        end_time_unix_seconds:
          type: integer
        resolution_seconds:
          type: integer
    MonitoringDataResult:
      type: object
      properties:
        request:
          $ref: '#/components/schemas/MonitoringDataRequest'
        dataseries:
          type: array
          items:
            type: string
        data_format:
          type: string
        data:
          type: array
          items:
            type: string
    MonitoringDatasetInfo:
      type: object
      properties:
        scope:
          type: string
        dataset:
          type: string
        earliest_data_time:
          type: integer
    MonitoringDatasets:
      type: object
      properties:
        datasets:
          type: array
          items:
            $ref: '#/components/schemas/MonitoringDatasetInfo'
    PfConfiguration:
      type: object
      properties:
        config:
          type: string
    FwIgnoredInput:
      type: object
      properties:
        v:
          type: boolean
    FwRulesEntry:
      type: object
      properties:
        rule:
          $ref: '#/components/schemas/FWFilterRule'
        separator:
          $ref: '#/components/schemas/FilterSeparator'
    FWRules:
      type: object
      properties:
        aliases:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/FWAddrAlias'
        entries:
          type: array
          items:
            $ref: '#/components/schemas/FwRulesEntry'
    InsertFilterSeparator:
      type: object
      properties:
        after:
          type: boolean
        color:
          type: string
        rule:
          type: string
        text:
          type: string
    InsertFilterRule:
      type: object
      properties:
        reference:
          type: string
        after:
          type: boolean
        rule:
          $ref: '#/components/schemas/FWFilterRule'
    FWBogonState:
      type: object
      properties:
        enabled:
          type: boolean
    FWRuleItemOrder:
      type: object
      properties:
        id:
          type: string
        rule:
          type: boolean
    FWRulesOrder:
      type: object
      properties:
        entries:
          type: array
          items:
            $ref: '#/components/schemas/FWRuleItemOrder'
    FwBulkDelete:
      type: object
      properties:
        rules:
          type: array
          items:
            type: string
    FwBulkCopy:
      type: object
      properties:
        iface:
          type: string
        rules:
          type: array
          items:
            type: string
    FwBulkToggle:
      type: object
      properties:
        rules:
          type: array
          items:
            type: string
        value:
          type: boolean
    FwRuleToggle:
      type: object
      properties:
        value:
          type: boolean
    Separator:
      type: object
      properties:
        row:
          type: string
        text:
          type: string
        color:
          type: string
        if:
          type: string
    FWAliases:
      type: object
      properties:
        aliases:
          type: array
          items:
            $ref: '#/components/schemas/FWAlias'
        system_aliases:
          type: array
          items:
            $ref: '#/components/schemas/FWSystemAlias'
    FWAliasReq:
      type: object
      properties:
        alias:
          $ref: '#/components/schemas/FWAlias'
    FWUpdateAliasreq:
      type: object
      properties:
        alias:
          $ref: '#/components/schemas/FWAlias'
        id:
          type: string
    FWSystemAlias:
      type: object
      properties:
        name:
          type: string
        type:
          type: string
        descr:
          type: string
        address:
          type: string
        url:
          type: string
        table:
          type: string
        if_ident:
          type: string
        if_assigned_name:
          type: string
    FWAlias:
      type: object
      properties:
        name:
          type: string
        address:
          type: string
        targets:
          type: array
          items:
            $ref: '#/components/schemas/FWTarget'
        descr:
          type: string
        type:
          type: string
        detail:
          type: string
        updatefreq:
          type: string
    FWTarget:
      type: object
      properties:
        name:
          type: string
        descr:
          type: string
        updatefreq:
          type: string
    NATRules:
      type: object
      properties:
        destlist:
          type: array
          items:
            $ref: '#/components/schemas/SimpleInterface'
        interfacelist:
          type: array
          items:
            $ref: '#/components/schemas/SimpleInterface'
        locallist:
          type: array
          items:
            $ref: '#/components/schemas/SimpleInterface'
        aliases:
          type: array
          items:
            $ref: '#/components/schemas/FWAlias'
        rules:
          type: array
          items:
            $ref: '#/components/schemas/NATRule'
        separators:
          type: array
          items:
            $ref: '#/components/schemas/Separator'
        srclist:
          type: array
          items:
            $ref: '#/components/schemas/SimpleInterface'
    FWRuleOrder:
      type: object
      properties:
        rule:
          type: array
          items:
            type: integer
        separator:
          type: array
          items:
            $ref: '#/components/schemas/Separator'
    FWToggleResult:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/ToggleRespStatus'
    ToggleRespStatus:
      type: object
      properties:
        disabled:
          type: boolean
        idx:
          type: integer
    FWUserTimestamp:
      type: object
      properties:
        time:
          type: string
        username:
          type: string
    FWAddrPort:
      type: object
      properties:
        label:
          type: string
        address:
          type: string
        network:
          type: string
        port:
          type: string
        not:
          type: boolean
        any:
          type: boolean
        alias_id:
          type: string
    FWAddrAlias:
      type: object
      description: System or user-defined alias details about the network defined in FWAddrPort.network
      properties:
        alias_type:
          type: string
        label:
          type: string
        descr:
          type: string
        table:
          type: string
        values:
          type: array
          items:
            type: string
    NATAddrPort:
      type: object
      properties:
        address:
          type: string
        network:
          type: string
        port:
          type: string
        any:
          type: boolean
    NATRule:
      type: object
      properties:
        idx:
          type: integer
        after:
          type: string
        associated_rule_id:
          type: string
        created:
          $ref: '#/components/schemas/FWUserTimestamp'
        descr:
          type: string
        disabled:
          type: boolean
        destination:
          $ref: '#/components/schemas/NATAddrPort'
        dst:
          type: string
        dstbeginport:
          type: string
        dstendport:
          type: string
        dstbeginport_cust:
          type: string
        dstendport_cust:
          type: string
        dstmask:
          type: string
        dstnot:
          type: boolean
        dsttype:
          type: string
        dup:
          type: string
        filter_rule_association:
          type: string
        interface:
          type: string
        ipprotocol:
          type: string
        local_port:
          type: string
        localbeginport:
          type: string
        localbeginport_cust:
          type: string
        localip:
          type: string
        localtype:
          type: string
        natreflection:
          type: string
        nordr:
          type: boolean
        protocol:
          type: string
        proto:
          type: string
        source:
          $ref: '#/components/schemas/NATAddrPort'
        src:
          type: string
        srcbeginport:
          type: string
        srcendport:
          type: string
        srcbeginport_cust:
          type: string
        srcendport_cust:
          type: string
        srcmask:
          type: string
        srcnot:
          type: boolean
        srctype:
          type: string
        target:
          type: string
        updated:
          $ref: '#/components/schemas/FWUserTimestamp'
    NATUpdateResult:
      type: object
      properties:
        rule:
          $ref: '#/components/schemas/NATRule'
    NAT1To1Rules:
      type: object
      properties:
        destlist:
          type: array
          items:
            $ref: '#/components/schemas/SimpleInterface'
        interfacelist:
          type: array
          items:
            $ref: '#/components/schemas/SimpleInterface'
        aliases:
          type: array
          items:
            $ref: '#/components/schemas/FWAlias'
        rules:
          type: array
          items:
            $ref: '#/components/schemas/NAT1To1Rule'
    NAT1To1Rule:
      type: object
      properties:
        after:
          type: string
        descr:
          type: string
        disabled:
          type: boolean
        destination:
          $ref: '#/components/schemas/NATAddrPort'
        dst:
          type: string
        dstmask:
          type: string
        dsttype:
          type: string
        dstnot:
          type: boolean
        dup:
          type: string
        external:
          type: string
        exttype:
          type: string
        idx:
          type: integer
        interface:
          type: string
        ipprotocol:
          type: string
        source:
          $ref: '#/components/schemas/NATAddrPort'
        src:
          type: string
        srcmask:
          type: string
        srcnot:
          type: boolean
        srctype:
          type: string
        target:
          type: string
    NAT1To1UpdateResult:
      type: object
      properties:
        rule:
          $ref: '#/components/schemas/NAT1To1Rule'
    NATNptRules:
      type: object
      properties:
        interfacelist:
          type: array
          items:
            $ref: '#/components/schemas/SimpleInterface'
        rules:
          type: array
          items:
            $ref: '#/components/schemas/NATNptRule'
    NATNptRule:
      type: object
      properties:
        after:
          type: string
        descr:
          type: string
        disabled:
          type: boolean
        destination:
          $ref: '#/components/schemas/NATSource'
        dst:
          type: string
        dstmask:
          type: string
        dstnot:
          type: boolean
        dup:
          type: string
        idx:
          type: integer
        interface:
          type: string
        source:
          $ref: '#/components/schemas/NATSource'
        src:
          type: string
        srcmask:
          type: string
        srcnot:
          type: boolean
    NATSource:
      type: object
      properties:
        address:
          type: string
        not:
          type: boolean
    NATNptUpdateResult:
      type: object
      properties:
        rule:
          $ref: '#/components/schemas/NATNptRule'
    NATOutboundRules:
      type: object
      properties:
        destlist:
          type: array
          items:
            $ref: '#/components/schemas/SimpleInterface'
        interfacelist:
          type: array
          items:
            $ref: '#/components/schemas/SimpleInterface'
        locallist:
          type: array
          items:
            $ref: '#/components/schemas/SimpleInterface'
        mode:
          type: string
        aliases:
          type: array
          items:
            $ref: '#/components/schemas/FWAlias'
        rules:
          type: array
          items:
            $ref: '#/components/schemas/NATOutboundRule'
        automatic_rules:
          type: array
          items:
            $ref: '#/components/schemas/NATAutoRule'
        srclist:
          type: array
          items:
            $ref: '#/components/schemas/SimpleInterface'
    NATAutoAddr:
      type: object
      properties:
        network:
          type: string
        any:
          type: boolean
    NATAutoRule:
      type: object
      properties:
        idx:
          type: integer
        interface:
          type: string
        dstport:
          type: string
        target:
          type: string
        destination:
          $ref: '#/components/schemas/NATAutoAddr'
        dstaddr:
          type: string
        source:
          $ref: '#/components/schemas/NATAutoAddr'
        dstany:
          type: boolean
        srcany:
          type: boolean
        srcaddr:
          type: string
        staticnatport:
          type: boolean
        descr:
          type: string
    NATOutboundRule:
      type: object
      properties:
        after:
          type: string
        created:
          $ref: '#/components/schemas/FWUserTimestamp'
        descr:
          type: string
        disabled:
          type: boolean
        destination:
          $ref: '#/components/schemas/FWAddrPort'
        dst:
          type: string
        dstport:
          type: string
        dstmask:
          type: string
        destination_type:
          type: string
        dup:
          type: string
        idx:
          type: integer
        interface:
          type: string
        ipprotocol:
          type: string
        natport:
          type: string
        nosync:
          type: boolean
        protocol:
          type: string
        source:
          $ref: '#/components/schemas/FWAddrPort'
        src:
          type: string
        sourceport:
          type: string
        srcmask:
          type: string
        srcnot:
          type: boolean
        source_type:
          type: string
        target:
          type: string
        targetip:
          type: string
        targetip_subnet:
          type: string
        updated:
          $ref: '#/components/schemas/FWUserTimestamp'
    NATOutUpdateResponse:
      type: object
      properties:
        rule:
          $ref: '#/components/schemas/NATOutboundRule'
    FWRuleStates:
      type: object
      properties:
        rules:
          type: array
          items:
            $ref: '#/components/schemas/FWRuleState'
    FWSingleRuleStates:
      type: object
      properties:
        rule:
          $ref: '#/components/schemas/FWRuleState'
    FWRuleState:
      type: object
      properties:
        id:
          type: string
        tracker:
          type: string
        label:
          type: string
        evaluations:
          type: integer
        packets:
          type: integer
        bytes:
          type: integer
        states:
          type: integer
        pid:
          type: integer
        state_creations:
          type: integer
    FWBogonRule:
      type: object
      properties:
        interface:
          type: string
        enabled:
          type: boolean
    FilterSeparator:
      type: object
      properties:
        row:
          type: string
        id:
          type: string
        text:
          type: string
        color:
          type: string
        if:
          type: string
    FWSingleFilterRule:
      type: object
      properties:
        rule:
          $ref: '#/components/schemas/FWFilterRule'
    FWFilterRule:
      type: object
      properties:
        id:
          type: string
        disabled:
          type: boolean
        readonly:
          type: boolean
        gateway:
          type: string
        tracker:
          type: string
        type:
          type: string
        interface:
          type: string
        ipprotocol:
          type: string
        tag:
          type: string
        tagged:
          type: string
        max:
          type: string
        max_src_nodes:
          type: string
        max_src_conn:
          type: string
        max_src_states:
          type: string
        statetimeout:
          type: string
        statetype:
          type: string
        state:
          $ref: '#/components/schemas/FWRuleState'
        os:
          type: string
        protocol:
          type: string
        floating:
          type: boolean
        direction:
          type: string
        quick:
          type: boolean
        log:
          type: boolean
        dscp:
          type: string
        allowopts:
          type: boolean
        disablereplyto:
          type: boolean
        nottagged:
          type: boolean
        pflow:
          type: boolean
        max_src_conn_rate:
          type: string
        max_src_conn_rates:
          type: string
        tcpflags1:
          type: string
        tcpflags2:
          type: string
        tcpflags1_struct:
          $ref: '#/components/schemas/TCPFlags'
        tcpflags2_struct:
          $ref: '#/components/schemas/TCPFlags'
        tcpflags_any:
          type: boolean
        icmptype:
          type: string
        nopfsync:
          type: boolean
        nosync:
          type: boolean
        vlanprio:
          type: string
        vlanprioset:
          type: string
        dnpipe:
          type: string
        pdnpipe:
          type: string
        ackqueue:
          type: string
        defaultqueue:
          type: string
        source:
          $ref: '#/components/schemas/FWAddrPort'
        sched:
          type: string
        destination:
          $ref: '#/components/schemas/FWAddrPort'
        descr:
          type: string
        updated:
          $ref: '#/components/schemas/FWUserTimestamp'
        created:
          $ref: '#/components/schemas/FWUserTimestamp'
    DeleteFirewallRule:
      type: object
      properties:
        id:
          type: string
    TCPFlags:
      type: object
      properties:
        fin:
          type: boolean
        syn:
          type: boolean
        rst:
          type: boolean
        psh:
          type: boolean
        ack:
          type: boolean
        urg:
          type: boolean
        ece:
          type: boolean
        cwr:
          type: boolean
    FWFirewallInterfaces:
      type: object
      properties:
        interfaces:
          type: array
          items:
            type: string
    FWSchedules:
      type: object
      properties:
        schedules:
          type: array
          items:
            $ref: '#/components/schemas/FWSchedule'
    FWSchedule:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        descr:
          type: string
        timerange:
          type: array
          items:
            $ref: '#/components/schemas/FWScheduleRange'
        schedlabel:
          type: string
    FWScheduleRange:
      type: object
      properties:
        position:
          type: string
        month:
          type: string
        day:
          type: string
        hour:
          type: string
        rangedescr:
          type: string
    QueryInterfaceRules:
      type: object
      properties:
        interface:
          type: string
    VirtualIPs:
      type: object
      properties:
        virtualips:
          type: array
          items:
            $ref: '#/components/schemas/VirtualIP'
        interfaces:
          type: array
          items:
            $ref: '#/components/schemas/SimpleInterface'
    VirtualIPResult:
      type: object
      properties:
        id:
          type: integer
    VirtualIP:
      type: object
      properties:
        mode:
          type: string
        interface:
          type: string
        vhid:
          type: integer
        advskew:
          type: integer
        advbase:
          type: integer
        password:
          type: string
        password_confirm:
          type: string
        uniqid:
          type: string
        descr:
          type: string
        subnet:
          type: string
        id:
          type: string
        carp_mode:
          type: string
    PFlowOptions:
      type: object
      properties:
        enable:
          type: boolean
        default:
          type: boolean
    PFlowExporter:
      type: object
      properties:
        id:
          type: string
        descr:
          type: string
        enable:
          type: boolean
        src:
          type: string
        srcport:
          type: integer
        dst:
          type: string
        dstport:
          type: integer
        proto:
          type: string
        domain:
          type: integer
    PFlowGlobalOptions:
      type: object
      properties:
        options:
          $ref: '#/components/schemas/PFlowOptions'
        exporters:
          type: array
          items:
            $ref: '#/components/schemas/PFlowExporter'
        src_ip_address:
          type: object
          additionalProperties:
            type: string
    L2TPSettings:
      type: object
      properties:
        l2tp:
          $ref: '#/components/schemas/L2TPConfig'
        interfaces:
          type: array
          items:
            type: string
    L2TPConfig:
      type: object
      properties:
        mode:
          type: string
        radius:
          $ref: '#/components/schemas/L2TPRadius'
        remoteip:
          type: string
        localip:
          type: string
        l2tp_subnet:
          type: string
        interface:
          type: string
        n_l2tp_units:
          type: string
        secret:
          type: string
        paporchap:
          type: string
        dns1:
          type: string
        dns2:
          type: string
        user:
          type: array
          items:
            $ref: '#/components/schemas/L2TPUser'
    L2TPRadius:
      type: object
      properties:
        server:
          type: string
        secret:
          type: string
        enable:
          type: boolean
        accounting:
          type: boolean
        radiusissueips:
          type: boolean
    L2TPUser:
      type: object
      properties:
        name:
          type: string
        ip:
          type: string
        password:
          type: string
    OpenVPNServers:
      type: object
      properties:
        authservers:
          type: array
          items:
            type: string
        servers:
          type: array
          items:
            $ref: '#/components/schemas/OpenVPNServerConfig'
    OpenVPNServer:
      type: object
      properties:
        authservers:
          type: array
          items:
            type: string
        server:
          $ref: '#/components/schemas/OpenVPNServerConfig'
    OpenVPNServerConfig:
      type: object
      properties:
        vpnid:
          type: string
        dco:
          type: boolean
        mode:
          type: string
        authmode:
          type: array
          items:
            type: string
        protocol:
          type: string
        dev_mode:
          type: string
        interface:
          type: string
        local_port:
          type: integer
        description:
          type: string
        tls:
          type: string
        tls_type:
          type: string
        certref:
          type: string
        caref:
          type: string
        dh_length:
          type: string
        data_ciphers:
          type: array
          items:
            type: string
        data_ciphers_fallback:
          type: string
        digest:
          type: string
        engine:
          type: string
        tunnel_network:
          type: string
        local_network:
          type: string
        maxclients:
          type: string
        allow_compression:
          type: string
        dynamic_ip:
          type: boolean
        topology:
          type: string
        dns_domain:
          type: string
        exit_notify:
          type: string
        inactive_seconds:
          type: string
        disable:
          type: boolean
        tlsauth_enable:
          type: boolean
        autotls_enable:
          type: boolean
        tlsauth_keydir:
          type: string
        ocspcheck:
          type: boolean
        ocspurl:
          type: string
        ecdh_curve:
          type: string
        autokey_enable:
          type: boolean
        shared_key:
          type: string
        cert_depth:
          type: string
        remote_cert_tls:
          type: boolean
        tunnel_networkv6:
          type: string
        serverbridge_dhcp:
          type: string
        serverbridge_interface:
          type: string
        serverbridge_routegateway:
          type: string
        serverbridge_dhcp_start:
          type: string
        serverbridge_dhcp_end:
          type: string
        gwredir:
          type: boolean
        gwredir6:
          type: boolean
        local_networkv6:
          type: string
        remote_network:
          type: string
        remote_networkv6:
          type: string
        compression:
          type: string
        compression_push:
          type: boolean
        passtos:
          type: boolean
        client2client:
          type: boolean
        duplicate_cn:
          type: boolean
        ping_method:
          type: string
        keepalive_interval:
          type: string
        keepalive_timeout:
          type: string
        ping_seconds:
          type: string
        ping_push:
          type: boolean
        ping_action:
          type: string
        ping_action_seconds:
          type: string
        ping_action_push:
          type: boolean
        dns_domain_enable:
          type: boolean
        dns_server_enable:
          type: boolean
        dns_server1:
          type: string
        dns_server2:
          type: string
        dns_server3:
          type: string
        dns_server4:
          type: string
        push_blockoutsidedns:
          type: boolean
        push_register_dns:
          type: boolean
        ntp_server_enable:
          type: boolean
        ntp_server1:
          type: string
        ntp_server2:
          type: string
        netbios_enable:
          type: boolean
        netbios_ntype:
          type: string
        netbios_scope:
          type: string
        wins_server_enable:
          type: boolean
        wins_server1:
          type: string
        wins_server2:
          type: string
        custom_options:
          type: string
        username_as_common_name:
          type: boolean
        udp_fast_io:
          type: boolean
        sndrcvbuf:
          type: string
        create_gw:
          type: string
        verbosity_level:
          type: string
        strictusercn:
          type: boolean
    SetOpenVPNServerResponse:
      type: object
      properties:
        vpnid:
          type: string
    OpenVPNClients:
      type: object
      properties:
        clients:
          type: array
          items:
            $ref: '#/components/schemas/OpenVPNClientConfig'
    OpenVPNClient:
      type: object
      properties:
        client:
          $ref: '#/components/schemas/OpenVPNClientConfig'
    SetOpenVPNClientResponse:
      type: object
      properties:
        vpnid:
          type: string
    OpenVPNClientConfig:
      type: object
      properties:
        vpnid:
          type: string
        disable:
          type: boolean
        dco:
          type: boolean
        protocol:
          type: string
        dev_mode:
          type: string
        interface:
          type: string
        ipaddr:
          type: string
        local_port:
          type: integer
        server_addr:
          type: string
        server_port:
          type: string
        proxy_addr:
          type: string
        proxy_port:
          type: string
        proxy_authtype:
          type: string
        description:
          type: string
        mode:
          type: string
        topology:
          type: string
        custom_options:
          type: string
        caref:
          type: string
        certref:
          type: string
        crlref:
          type: string
        tlsauth_enable:
          type: boolean
        autokey_enable:
          type: boolean
        autotls_enable:
          type: boolean
        tls:
          type: string
        tls_type:
          type: string
        tlsauth_keydir:
          type: string
        remote_cert_tls:
          type: boolean
        shared_key:
          type: string
        digest:
          type: string
        tunnel_network:
          type: string
        tunnel_networkv6:
          type: string
        remote_network:
          type: string
        remote_networkv6:
          type: string
        use_shaper:
          type: string
        allow_compression:
          type: string
        compression:
          type: string
        auth-retry-none:
          type: boolean
        passtos:
          type: boolean
        udp_fast_io:
          type: boolean
        exit_notify:
          type: string
        sndrcvbuf:
          type: string
        route_no_pull:
          type: boolean
        route_no_exec:
          type: boolean
        dns_add:
          type: boolean
        verbosity_level:
          type: string
        create_gw:
          type: string
        dh_length:
          type: string
        data_ciphers:
          type: array
          items:
            type: string
        data_ciphers_fallback:
          type: string
        ping_method:
          type: string
        keepalive_interval:
          type: string
        keepalive_timeout:
          type: string
        ping_seconds:
          type: string
        ping_action:
          type: string
        ping_action_seconds:
          type: string
        inactive_seconds:
          type: string
    OpenVPNCSOs:
      type: object
      properties:
        cscs:
          type: array
          items:
            $ref: '#/components/schemas/OpenVPNCSOConfig'
    OpenVPNCSO:
      type: object
      properties:
        csc:
          $ref: '#/components/schemas/OpenVPNCSOConfig'
    SetOpenVPNCSOResponse:
      type: object
      properties:
        id:
          type: string
    OpenVPNCSOConfig:
      type: object
      properties:
        disable:
          type: boolean
        server_list:
          type: string
        common_name:
          type: string
        block:
          type: boolean
        description:
          type: string
        tunnel_network:
          type: string
        tunnel_networkv6:
          type: string
        local_network:
          type: string
        local_networkv6:
          type: string
        remote_network:
          type: string
        remote_networkv6:
          type: string
        gwredir:
          type: boolean
        push_reset:
          type: boolean
        remove_route:
          type: boolean
        dns_domain_enable:
          type: boolean
        dns_domain:
          type: string
        dns_server_enable:
          type: boolean
        dns_server1:
          type: string
        dns_server2:
          type: string
        dns_server3:
          type: string
        dns_server4:
          type: string
        ntp_server_enable:
          type: boolean
        ntp_server1:
          type: string
        ntp_server2:
          type: string
        netbios_enable:
          type: boolean
        netbios_ntype:
          type: string
        netbios_scope:
          type: string
        wins_server_enable:
          type: boolean
        wins_server1:
          type: string
        wins_server2:
          type: string
        nbdd_server_enable:
          type: boolean
        nbdd_server1:
          type: string
        nbdd_server2:
          type: string
        custom_options:
          type: string
    OpenVPNStatus:
      type: object
      properties:
        servers:
          type: array
          items:
            $ref: '#/components/schemas/OpenVPNActiveConn'
        sk_servers:
          type: array
          items:
            $ref: '#/components/schemas/OpenVPNActiveConn'
        clients:
          type: array
          items:
            $ref: '#/components/schemas/OpenVPNActiveConn'
    OpenVPNActiveConn:
      type: object
      properties:
        vpnid:
          type: string
        port:
          type: string
        mode:
          type: string
        name:
          type: string
        mgmt:
          type: string
        conns:
          type: array
          items:
            $ref: '#/components/schemas/OpenVPNConn'
        routes:
          type: array
          items:
            $ref: '#/components/schemas/OpenVPNRoute'
        connect_time:
          type: string
        state:
          type: string
        state_detail:
          type: string
        virtual_addr:
          type: string
        remote_host:
          type: string
        remote_port:
          type: string
        local_host:
          type: string
        local_port:
          type: string
        virtual_addr6:
          type: string
        status:
          type: string
        bytes_recv:
          type: string
        bytes_sent:
          type: string
    OpenVPNConn:
      type: object
      properties:
        common_name:
          type: string
        remote_host:
          type: string
        virtual_addr:
          type: string
        virtual_addr6:
          type: string
        bytes_recv:
          type: string
        bytes_sent:
          type: string
        connect_time:
          type: string
        connect_time_unix:
          type: string
        user_name:
          type: string
        client_id:
          type: string
        peer_id:
          type: string
        cipher:
          type: string
    OpenVPNRoute:
      type: object
      properties:
        virtual_addr:
          type: string
        common_name:
          type: string
        remote_host:
          type: string
        last_time:
          type: string
    WGConfig:
      type: object
      description: |
        valid values:
        enable = "on", "off"
        keep_conf = "yes", "no"
        resolve_interval_track = "yes", "no"
        interface_group = "all", "unassigned", "none"
        hide_secrets = "yes", "no"
        hide_peers = "yes", "no"
      properties:
        enable:
          type: boolean
        keep_conf:
          type: boolean
        resolve_interval:
          type: string
        resolve_interval_track:
          type: boolean
        interface_group:
          type: string
        hide_secrets:
          type: boolean
        hide_peers:
          type: boolean
    WGIPAddress:
      type: object
      properties:
        address:
          type: string
        mask:
          type: string
        descr:
          type: string
    WGIPAddresses:
      type: object
      properties:
        row:
          type: array
          items:
            $ref: '#/components/schemas/WGIPAddress'
    WGPeer:
      type: object
      description: |
        valid values:
        enabled = "yes", "no"
      properties:
        enabled:
          type: boolean
        tun:
          type: string
        descr:
          type: string
        endpoint:
          type: string
        port:
          type: string
        persistentkeepalive:
          type: string
        publickey:
          type: string
        presharedkey:
          type: string
        allowedips:
          $ref: '#/components/schemas/WGIPAddresses'
    WGPeers:
      type: object
      properties:
        item:
          type: array
          items:
            $ref: '#/components/schemas/WGPeer'
    WGTunnelConf:
      type: object
      properties:
        conf:
          type: string
    WGTunnel:
      type: object
      description: |
        valid values:
        enabled = "yes", "no"
      properties:
        name:
          type: string
        descr:
          type: string
        enabled:
          type: boolean
        listenport:
          type: string
        privatekey:
          type: string
        publickey:
          type: string
        mtu:
          type: string
        addresses:
          $ref: '#/components/schemas/WGIPAddresses'
    WGTunnels:
      type: object
      properties:
        item:
          type: array
          items:
            $ref: '#/components/schemas/WGTunnel'
    WireGuardSettings:
      type: object
      properties:
        config:
          type: array
          items:
            $ref: '#/components/schemas/WGConfig'
        tunnels:
          $ref: '#/components/schemas/WGTunnels'
        peers:
          $ref: '#/components/schemas/WGPeers'
    WireGuardPeerStatus:
      type: object
      properties:
        public_key:
          type: string
        preshared_key:
          type: string
        endpoint:
          type: string
        allowed_ips:
          type: string
        latest_handshake:
          type: string
        transfer_rx:
          type: string
        transfer_tx:
          type: string
        persistent_keepalive:
          type: string
        config:
          $ref: '#/components/schemas/WGPeer'
    WireGuardTunnelStatus:
      type: object
      properties:
        private_key:
          type: string
        public_key:
          type: string
        listen_port:
          type: string
        fwmark:
          type: string
        status:
          type: string
        transfer_rx:
          type: integer
        transfer_tx:
          type: integer
        inpkts:
          type: integer
        outpkts:
          type: integer
        mtu:
          type: integer
        config:
          $ref: '#/components/schemas/WGTunnel'
        peers:
          type: array
          items:
            $ref: '#/components/schemas/WireGuardPeerStatus'
    WireGuardStatus:
      type: object
      properties:
        status:
          type: array
          items:
            $ref: '#/components/schemas/WireGuardTunnelStatus'
    WireGuardKeys:
      type: object
      properties:
        privkey:
          type: string
          format: byte
        privkey_clamped:
          type: string
          format: byte
        pubkey:
          type: string
          format: byte
        was_clamped:
          type: boolean
    EncryptionAlgorithm:
      type: object
      properties:
        name:
          type: string
        keylen:
          type: string
    Phase1Alg:
      type: object
      properties:
        encryption_algorithm:
          $ref: '#/components/schemas/EncryptionAlgorithm'
        hash_algorithm:
          type: string
        prf_algorithm:
          type: string
        dhgroup:
          type: string
    Phase1Encryption:
      type: object
      properties:
        item:
          type: array
          items:
            $ref: '#/components/schemas/Phase1Alg'
    Phase1:
      type: object
      properties:
        ikeid:
          type: string
        iketype:
          type: string
        interface:
          type: string
        remote_gateway:
          type: string
        protocol:
          type: string
        myid_type:
          type: string
        myid_data:
          type: string
        peerid_type:
          type: string
        peerid_data:
          type: string
        encryption:
          $ref: '#/components/schemas/Phase1Encryption'
        lifetime:
          type: integer
        rekey_time:
          type: integer
        reauth_time:
          type: integer
        rand_time:
          type: integer
        pre_shared_key:
          type: string
        private_key:
          type: string
        certref:
          type: string
        pkcs11certref:
          type: string
        pkcs11pin:
          type: string
        caref:
          type: string
        authentication_method:
          type: string
        descr:
          type: string
        nat_traversal:
          type: string
        mobike:
          type: string
        startaction:
          type: string
        closeaction:
          type: string
        dpd_delay:
          type: integer
        dpd_maxfail:
          type: integer
        prfselect_enable:
          type: boolean
        gw_duplicates:
          type: boolean
        mobile:
          type: boolean
        disabled:
          type: boolean
    Phase2LocalId:
      type: object
      properties:
        type:
          type: string
        address:
          type: string
        netbits:
          type: string
    Phase2RemoteId:
      type: object
      properties:
        type:
          type: string
        address:
          type: string
        netbits:
          type: string
    Phase2:
      type: object
      properties:
        ikeid:
          type: string
        uniqid:
          type: string
        mode:
          type: string
        reqid:
          type: string
        localid:
          $ref: '#/components/schemas/Phase2LocalId'
        remoteid:
          $ref: '#/components/schemas/Phase2RemoteId'
        protocol:
          type: string
        encryption_algorithm_option:
          type: array
          items:
            $ref: '#/components/schemas/EncryptionAlgorithm'
        hash_algorithm_option:
          type: array
          items:
            type: string
        pfsgroup:
          type: string
        lifetime:
          type: integer
        rekey_time:
          type: integer
        rand_time:
          type: integer
        pinghost:
          type: string
        keepalive:
          type: boolean
        mobile:
          type: boolean
        disabled:
          type: boolean
        descr:
          type: string
    IPSecMobileKey:
      type: object
      properties:
        ident:
          type: string
        type:
          type: string
        pre_shared_key:
          type: string
        ident_type:
          type: string
        pool_address:
          type: string
        pool_netbits:
          type: string
        dns_address:
          type: string
    IPSecClient:
      type: object
      properties:
        enable:
          type: boolean
        radiusaccounting:
          type: boolean
        user_source:
          type: string
        user_source_array:
          type: array
          items:
            type: string
        group_source:
          type: boolean
        auth_groups:
          type: string
        auth_groups_array:
          type: array
          items:
            type: string
        pool_address:
          type: string
        pool_netbits:
          type: string
        pool_address_v6:
          type: string
        pool_netbits_v6:
          type: string
        net_list:
          type: boolean
        save_passwd:
          type: boolean
        dns_domain:
          type: string
        dns_split:
          type: string
        dns_server1:
          type: string
        dns_server2:
          type: string
        dns_server3:
          type: string
        dns_server4:
          type: string
        wins_server1:
          type: string
        wins_server2:
          type: string
        pfs_group:
          type: string
        login_banner:
          type: string
        radius_ip_priority_enable:
          type: boolean
        radius_retransmit_base:
          type: string
        radius_retransmit_timeout:
          type: string
        radius_retransmit_tries:
          type: string
        radius_sockets:
          type: string
    IPSecBypassRule:
      type: object
      properties:
        source:
          type: string
        sourcemask:
          type: string
        destination:
          type: string
        dstmask:
          type: string
    IPSecBypassRules:
      type: object
      properties:
        rules:
          type: array
          items:
            $ref: '#/components/schemas/IPSecBypassRule'
    IPSecLogging:
      type: object
      properties:
        dmn:
          type: string
        mgr:
          type: string
        ike:
          type: string
        chd:
          type: string
        job:
          type: string
        cfg:
          type: string
        knl:
          type: string
        net:
          type: string
        asn:
          type: string
        enc:
          type: string
        imc:
          type: string
        imv:
          type: string
        pts:
          type: string
        tls:
          type: string
        esp:
          type: string
        lib:
          type: string
    IPSecConfig:
      type: object
      properties:
        logging:
          $ref: '#/components/schemas/IPSecLogging'
        async_crypto:
          type: boolean
        uniqueids:
          type: string
        filtermode:
          type: string
        bypassrules:
          $ref: '#/components/schemas/IPSecBypassRules'
        pkcs11support:
          type: boolean
        enableinterfacesuse:
          type: boolean
        unityplugin:
          type: boolean
        strictcrlpolicy:
          type: boolean
        makebeforebreak:
          type: boolean
        ipsecbypass:
          type: boolean
        acceptunencryptedmainmode:
          type: boolean
        maxexchange:
          type: integer
        port_nat_t:
          type: integer
        port:
          type: integer
        compression:
          type: boolean
        noshuntlaninterfaces:
          type: boolean
        maxmss:
          type: string
    IPSecPhaseList:
      type: object
      properties:
        phase1:
          type: array
          items:
            $ref: '#/components/schemas/Phase1'
        phase2:
          type: array
          items:
            $ref: '#/components/schemas/Phase2'
    IPSecPhases:
      type: object
      properties:
        phases:
          $ref: '#/components/schemas/IPSecPhaseList'
    IPSecClientConfig:
      type: object
      properties:
        client:
          $ref: '#/components/schemas/IPSecClient'
        user_groups:
          type: array
          items:
            $ref: '#/components/schemas/UserGroup'
        auth_servers:
          $ref: '#/components/schemas/AuthServers'
    IPSecMobileKeys:
      type: object
      properties:
        keys:
          type: array
          items:
            $ref: '#/components/schemas/IPSecMobileKey'
    IPSecSPD:
      type: object
      properties:
        dir:
          type: string
        scope:
          type: string
        ifname:
          type: string
        srcid:
          type: string
        dstid:
          type: string
        proto:
          type: string
        src:
          type: string
        dst:
          type: string
        unique:
          type: string
    IPSecSAD:
      type: object
      properties:
        src:
          type: string
        dst:
          type: string
        proto:
          type: string
        spi:
          type: string
        reqid:
          type: string
        ealgo:
          type: string
        aalgo:
          type: string
        data:
          type: string
    IPSecPool:
      type: object
      properties:
        name:
          type: string
        base:
          type: string
        online:
          type: string
        offline:
          type: string
        size:
          type: string
        host:
          type: string
        status:
          type: string
        id:
          type: string
    IPSecChildSAS:
      type: object
      properties:
        name:
          type: string
        uniqueid:
          type: string
        reqid:
          type: string
        state:
          type: string
        mode:
          type: string
        protocol:
          type: string
        encap:
          type: string
        spi_in:
          type: string
        spi_out:
          type: string
        cpi_in:
          type: string
        cpi_out:
          type: string
        mark_in:
          type: string
        mark_mask_in:
          type: string
        mark_out:
          type: string
        mark_mask_out:
          type: string
        if_id_in:
          type: string
        if_id_out:
          type: string
        label:
          type: string
        encr_alg:
          type: string
        encr_keysize:
          type: string
        integ_alg:
          type: string
        integ_keysize:
          type: string
        prf_alg:
          type: string
        dh_group:
          type: string
        esn:
          type: string
        bytes_in:
          type: integer
        packets_in:
          type: integer
        use_in:
          type: integer
        bytes_out:
          type: integer
        packets_out:
          type: integer
        use_out:
          type: integer
        rekey_time:
          type: integer
        life_time:
          type: integer
        install_time:
          type: integer
        local_ts:
          type: array
          items:
            type: string
        remote_ts:
          type: array
          items:
            type: string
    IPSecIKESA:
      type: object
      properties:
        name:
          type: string
        uniqueid:
          type: string
        version:
          type: integer
        state:
          type: string
        local_host:
          type: string
        local_port:
          type: string
        local_id:
          type: string
        remote_host:
          type: string
        remote_port:
          type: string
        remote_id:
          type: string
        initiator:
          type: string
        initiator_spi:
          type: string
        responder_spi:
          type: string
        encr_alg:
          type: string
        encr_keysize:
          type: integer
        integ_alg:
          type: string
        integ_keysize:
          type: integer
        prf_alg:
          type: string
        dh_group:
          type: string
        established:
          type: integer
        rekey_time:
          type: integer
        reauth_time:
          type: integer
        childsas:
          type: array
          items:
            $ref: '#/components/schemas/IPSecChildSAS'
    IPSecStatus:
      type: object
      properties:
        list_sa:
          type: array
          items:
            $ref: '#/components/schemas/IPSecIKESA'
        phases:
          $ref: '#/components/schemas/IPSecPhaseList'
    IPSecStatusOverview:
      type: object
      properties:
        enabled:
          type: boolean
        daemon_running:
          type: boolean
        status:
          $ref: '#/components/schemas/IPSecStatus'
        lease:
          type: array
          items:
            $ref: '#/components/schemas/IPSecPool'
        sads:
          type: array
          items:
            $ref: '#/components/schemas/IPSecSAD'
        spds:
          type: array
          items:
            $ref: '#/components/schemas/IPSecSPD'
    InterfaceSimple:
      type: object
      properties:
        name:
          type: string
        descr:
          type: string
        if:
          type: string
        ipaddr:
          type: string
        ipaddrv6:
          type: string
        mac:
          type: string
        tag:
          type: integer
        member:
          type: string
        addresses:
          type: array
          items:
            type: string
        enable:
          type: boolean
    InterfacesSimple:
      type: object
      properties:
        interfaces:
          type: array
          items:
            $ref: '#/components/schemas/InterfaceSimple'
    NewInterfaceResult:
      type: object
      properties:
        name:
          type: string
    InterfaceDescriptorsInfo:
      type: object
      description: |
        Each of these should have strict definition for different types of
        interfaces, ie GIFInterface, GREInterface, LAGGInterface, etc.
      properties:
        gre:
          type: object
          additionalProperties:
            type: string
        gif:
          type: object
          additionalProperties:
            type: string
        lagg:
          type: object
          additionalProperties:
            type: string
        qinq:
          type: object
          additionalProperties:
            type: string
        ppp:
          type: object
          additionalProperties:
            type: string
        bridges:
          type: object
          additionalProperties:
            type: string
        vlan:
          type: object
          additionalProperties:
            type: string
        physical:
          type: object
          additionalProperties:
            type: string
    InterfaceDescriptors:
      type: object
      properties:
        descriptors:
          $ref: '#/components/schemas/InterfaceDescriptorsInfo'
    InterfacesFriendly:
      type: object
      properties:
        interfaces:
          type: array
          items:
            $ref: '#/components/schemas/InterfaceFriendlyName'
    InterfaceFriendlyName:
      type: object
      properties:
        if:
          type: string
        name:
          type: string
    PhysicalInterface:
      type: object
      description: a physical interface port
      properties:
        name:
          type: string
        mac:
          type: string
        up:
          type: boolean
        ipaddr:
          type: string
        friendly:
          type: string
        dmesg:
          type: string
    InterfacePortsLists:
      type: object
      properties:
        gres:
          type: array
          items:
            $ref: '#/components/schemas/GREInterface'
        gifs:
          type: array
          items:
            $ref: '#/components/schemas/GIFInterface'
        bridges:
          type: array
          items:
            $ref: '#/components/schemas/BridgeInterface'
        vlans:
          type: array
          items:
            $ref: '#/components/schemas/VLANInterface'
        ppps:
          type: array
          items:
            $ref: '#/components/schemas/PPPInterface'
        qinqs:
          type: array
          items:
            $ref: '#/components/schemas/QinQInterface'
        laggs:
          type: array
          items:
            $ref: '#/components/schemas/LAGGInterface'
        wan:
          $ref: '#/components/schemas/Interface'
        lan:
          $ref: '#/components/schemas/Interface'
        physical:
          type: array
          items:
            $ref: '#/components/schemas/PhysicalInterface'
    InterfacePorts:
      type: object
      properties:
        ports:
          $ref: '#/components/schemas/InterfacePortsLists'
        modems:
          type: array
          items:
            type: string
    BridgeInterface:
      type: object
      properties:
        members:
          type: string
        enablestp:
          type: boolean
        descr:
          type: string
        maxaddr:
          type: string
        timeout:
          type: string
        maxage:
          type: string
        fwdelay:
          type: string
        hellotime:
          type: string
        priority:
          type: string
        proto:
          type: string
        holdcnt:
          type: string
        ip6linklocal:
          type: boolean
        ifpriority:
          type: string
        ifpathcost:
          type: string
        paths:
          type: object
          additionalProperties:
            type: string
        priorities:
          type: object
          additionalProperties:
            type: string
        static:
          type: string
        private:
          type: string
        stp:
          type: string
        span:
          type: string
        edge:
          type: string
        autoedge:
          type: string
        ptp:
          type: string
        autoptp:
          type: string
        bridgeif:
          type: string
    BridgeInterfaces:
      type: object
      properties:
        interfaces:
          type: array
          items:
            $ref: '#/components/schemas/BridgeInterface'
    GIFInterface:
      type: object
      properties:
        name:
          type: string
        if:
          type: string
        ipaddr:
          type: string
        tunnel_local_addr:
          type: string
        tunnel_remote_addr:
          type: string
        tunnel_remote_net:
          type: string
        remote_addr:
          type: string
        descr:
          type: string
        link1:
          type: boolean
        link2:
          type: boolean
        gifif:
          type: string
    GIFInterfaces:
      type: object
      properties:
        interfaces:
          type: array
          items:
            $ref: '#/components/schemas/GIFInterface'
    GREInterface:
      type: object
      properties:
        if:
          type: string
        tunnel_local_addr:
          type: string
        tunnel_remote_addr:
          type: string
        tunnel_local_addr6:
          type: string
        tunnel_remote_addr6:
          type: string
        tunnel_remote_net:
          type: string
        tunnel_remote_net6:
          type: string
        remote_addr:
          type: string
        descr:
          type: string
        link1:
          type: boolean
        greif:
          type: string
    GREInterfaces:
      type: object
      properties:
        interfaces:
          type: array
          items:
            $ref: '#/components/schemas/GREInterface'
    InterfaceGroup:
      type: object
      properties:
        members:
          type: string
        member:
          type: array
          items:
            type: string
        descr:
          type: string
        ifname:
          type: string
    InterfaceGroups:
      type: object
      properties:
        groups:
          type: array
          items:
            $ref: '#/components/schemas/InterfaceGroup'
    LAGGInterface:
      type: object
      properties:
        members:
          type: string
        descr:
          type: string
        laggif:
          type: string
        proto:
          type: string
        failovermaster:
          type: string
        lacptimeout:
          type: string
    LAGGInterfaces:
      type: object
      properties:
        interfaces:
          type: array
          items:
            $ref: '#/components/schemas/LAGGInterface'
    PPPInterface:
      type: object
      properties:
        ptpid:
          type: string
        type:
          type: string
        if:
          type: string
        ports:
          type: string
        portslist:
          type: array
          items:
            type: string
        phone:
          type: string
        apn:
          type: string
        apnum:
          type: string
        simpin:
          type: string
        country:
          type: string
        provider:
          type: string
        provider_list:
          type: string
        providerplan:
          type: string
        pin_wait:
          type: string
        initstr:
          type: string
        connect_timeout:
          type: string
        uptime:
          type: boolean
        username:
          type: string
        ppp_username:
          type: string
        ppp_password:
          type: string
        pppoe_password:
          type: string
        pppoe_username:
          type: string
        password:
          type: string
        ondemand:
          type: boolean
        idletimeout:
          type: string
        pppoe_idletimeout:
          type: string
        descr:
          type: string
        localip:
          type: string
        gateway:
          type: string
        pppoe_reset_type:
          type: string
        pppoe_resethour:
          type: string
        pppoe_resetminute:
          type: string
        pppoe_resetdate:
          type: string
        pppoe_pr_preset_val:
          type: string
        pppoe_dialondemand:
          type: boolean
        hostuniq:
          type: string
        pptp_dialondemand:
          type: boolean
        pptp_idletimeout:
          type: string
        pptp_local0:
          type: string
        pptp_password:
          type: string
        pptp_remote0:
          type: string
        pptp_username:
          type: string
        l2tp_secret:
          type: string
        shortseq:
          type: boolean
        acfcomp:
          type: boolean
        protocomp:
          type: boolean
        pppoe_multilink_over_singlelink:
          type: boolean
        mtu_override:
          type: boolean
        vjcomp:
          type: boolean
        tcpmssfix:
          type: boolean
        secret:
          type: string
        bandwidth:
          type: string
        mtu:
          type: string
        mru:
          type: string
        mrru:
          type: string
        port:
          type: string
    PPPInterfaces:
      type: object
      properties:
        interfaces:
          type: array
          items:
            $ref: '#/components/schemas/PPPInterface'
    PPPInterfacesModems:
      type: object
      properties:
        interfaces:
          type: array
          items:
            $ref: '#/components/schemas/PPPInterface'
        modems:
          type: array
          items:
            type: string
    QinQInterface:
      type: object
      properties:
        if_device:
          type: string
        if_assigned_name:
          type: string
        tag:
          type: integer
        autogroup:
          type: boolean
        members:
          type: string
        member:
          type: array
          items:
            type: string
        descr:
          type: string
        vlanif:
          type: string
    QinQInterfaces:
      type: object
      properties:
        interfaces:
          type: array
          items:
            $ref: '#/components/schemas/QinQInterface'
        vlan_capable_ifs:
          type: array
          items:
            $ref: '#/components/schemas/VLANCapableInterface'
    VLANInterface:
      type: object
      properties:
        if_device:
          type: string
        if_assigned_name:
          type: string
        tag:
          type: integer
        pcp:
          type: integer
        descr:
          type: string
        vlanif:
          type: string
    VLANCapableInterface:
      type: object
      properties:
        if_device:
          type: string
        if_assigned_name:
          type: string
        mac:
          type: string
        up:
          type: boolean
        ipaddr:
          type: string
        dmesg:
          type: string
    VLANInterfaces:
      type: object
      properties:
        interfaces:
          type: array
          items:
            $ref: '#/components/schemas/VLANInterface'
        vlan_capable_ifs:
          type: array
          items:
            $ref: '#/components/schemas/VLANCapableInterface'
    WirelessInterface:
      type: object
      properties:
        mode:
          type: string
        standard:
          type: string
        protmode:
          type: string
        ssid:
          type: string
        channel:
          type: string
        authmode:
          type: string
        txpower:
          type: string
        distance:
          type: string
        regdomain:
          type: string
        regcountry:
          type: string
        reglocation:
          type: string
        wpa:
          $ref: '#/components/schemas/WPASetting'
        auth_server_addr:
          type: string
        auth_server_port:
          type: string
        auth_server_shared_secret:
          type: string
        auth_server_addr2:
          type: string
        auth_server_port2:
          type: string
        auth_server_shared_secret2:
          type: string
        wme:
          $ref: '#/components/schemas/WMESetting'
        channel_width:
          type: string
    WPASetting:
      type: object
      properties:
        macaddr_acl:
          type: string
        wpa_mode:
          type: string
        wpa_key_mgmt:
          type: string
        wpa_pairwise:
          type: string
        wpa_group_rekey:
          type: string
        wpa_gmk_rekey:
          type: string
        passphrase:
          type: string
        ext_wpa_sw:
          type: string
    WMESetting:
      type: object
      properties:
        enable:
          type: boolean
    WirelessAddl:
      type: object
      properties:
        clone:
          $ref: '#/components/schemas/WirelessAddlClone'
    WirelessAddlClone:
      type: object
      properties:
        if:
          type: string
        mode:
          type: string
        descr:
          type: string
        cloneif:
          type: string
    WirelessInterfaces:
      type: object
      properties:
        interfaces:
          type: array
          items:
            $ref: '#/components/schemas/WirelessInterface'
        interfacesClone:
          type: array
          items:
            $ref: '#/components/schemas/WirelessAddl'
    Interface:
      type: object
      description: Detailed interface information
      properties:
        name:
          type: string
        enable:
          type: boolean
        blockbogons:
          type: boolean
        pseudo:
          type: boolean
        blockpriv:
          type: boolean
        slaacusev4iface:
          type: boolean
        if:
          type: string
        descr:
          type: string
        type:
          type: string
        type6:
          type: string
        mtu:
          type: integer
        mss:
          type: integer
        pcp:
          type: integer
        promisc:
          type: boolean
        ipaddr:
          type: string
        member:
          type: string
        media:
          type: string
        mac:
          type: string
        mediaopt:
          type: string
        spoofmac:
          type: string
        tag:
          type: integer
        gateway:
          type: string
        ipaddrv6:
          type: string
        ipv6usev4iface:
          type: boolean
        defaultgw6:
          type: boolean
        gatewayip6:
          type: string
        gatewayv6:
          type: string
        gatewaydescr6:
          type: string
        gatewayname6:
          type: string
        alias_address:
          type: string
        dhcphostname:
          type: string
        dhcprejectfrom:
          type: string
        dhcprejectfromarray:
          type: array
          items:
            type: string
        dhcpvlanenable:
          type: boolean
        dhcp6usev4iface:
          type: boolean
        dhcp6prefixonly:
          type: boolean
        dhcp6_ia_pd_send_hint:
          type: boolean
        dhcp6debug:
          type: boolean
        dhcp6withoutra:
          type: boolean
        dhcp6norelease:
          type: boolean
        dhcpcvpt:
          type: string
        dhcp6cvpt:
          type: string
        prefix_6rd:
          type: string
        gateway_6rd:
          type: string
        track6_prefix_id__hex:
          type: string
        dhcp6_ia_pd_len:
          type: string
        prefix_6rd_v4plen:
          type: string
        track6_interface:
          type: string
        adv_dhcp_config_advanced:
          type: boolean
        adv_dhcp_config_file_override:
          type: boolean
        adv_dhcp_pt_timeout:
          type: string
        adv_dhcp_pt_retry:
          type: string
        adv_dhcp_pt_select_timeout:
          type: string
        adv_dhcp_pt_reboot:
          type: string
        adv_dhcp_pt_backoff_cutoff:
          type: string
        adv_dhcp_pt_initial_interval:
          type: string
        adv_dhcp_pt_values:
          type: string
        adv_dhcp_config_file_override_path:
          type: string
        adv_dhcp_send_options:
          type: string
        adv_dhcp_request_options:
          type: string
        adv_dhcp_required_options:
          type: string
        adv_dhcp_option_modifiers:
          type: string
        adv_dhcp6_config_advanced:
          type: boolean
        adv_dhcp6_config_file_override:
          type: boolean
        adv_dhcp6_prefix_selected_interface:
          type: string
        adv_dhcp6_config_file_override_path:
          type: string
        adv_dhcp6_interface_statement_information_only_enable:
          type: boolean
        adv_dhcp6_interface_statement_send_options:
          type: string
        adv_dhcp6_interface_statement_request_options:
          type: string
        adv_dhcp6_interface_statement_script:
          type: string
        adv_dhcp6_id_assoc_statement_address_enable:
          type: boolean
        adv_dhcp6_id_assoc_statement_address_id:
          type: string
        adv_dhcp6_id_assoc_statement_address:
          type: string
        adv_dhcp6_id_assoc_statement_address_pltime:
          type: string
        adv_dhcp6_id_assoc_statement_address_vltime:
          type: string
        adv_dhcp6_id_assoc_statement_prefix_enable:
          type: boolean
        adv_dhcp6_id_assoc_statement_prefix_id:
          type: string
        adv_dhcp6_id_assoc_statement_prefix:
          type: string
        adv_dhcp6_id_assoc_statement_prefix_pltime:
          type: string
        adv_dhcp6_id_assoc_statement_prefix_vltime:
          type: string
        adv_dhcp6_prefix_interface_statement_sla_id:
          type: string
        adv_dhcp6_prefix_interface_statement_sla_len:
          type: string
        adv_dhcp6_authentication_statement_authname:
          type: string
        adv_dhcp6_authentication_statement_protocol:
          type: string
        adv_dhcp6_authentication_statement_algorithm:
          type: string
        adv_dhcp6_authentication_statement_rdm:
          type: string
        adv_dhcp6_key_info_statement_keyname:
          type: string
        adv_dhcp6_key_info_statement_realm:
          type: string
        adv_dhcp6_key_info_statement_keyid:
          type: string
        adv_dhcp6_key_info_statement_secret:
          type: string
        adv_dhcp6_key_info_statement_expire:
          type: string
    Interfaces:
      type: object
      properties:
        interface:
          type: array
          items:
            $ref: '#/components/schemas/Interface'
    DiagActivity:
      type: object
      properties:
        activity:
          type: string
          format: byte
    ArpTableEntry:
      type: object
      properties:
        ip:
          type: string
        mac:
          type: string
        interface:
          type: string
        expires:
          type: string
        type:
          type: string
        dnsresolve:
          type: string
    DiagArpTable:
      type: object
      properties:
        arp:
          type: array
          items:
            $ref: '#/components/schemas/ArpTableEntry'
    DiagAuthServerList:
      type: object
      properties:
        servers:
          type: array
          items:
            type: string
        authtype:
          type: string
    DiagAuthTestRequest:
      type: object
      properties:
        authtype:
          type: string
        username:
          type: string
          format: byte
        password:
          type: string
          format: byte
    DiagAuthTestResult:
      type: object
      properties:
        authtype:
          type: string
        groups:
          type: array
          items:
            type: string
        authenticated:
          type: boolean
    DiagBackupRequest:
      type: object
      properties:
        area:
          type: string
        nopkg:
          type: boolean
        norrd:
          type: boolean
        enc:
          type: boolean
        pwd:
          type: string
        filename:
          type: string
        contents:
          type: string
    DiagBackupInfo:
      type: object
      properties:
        time:
          type: integer
        desc:
          type: string
        size:
          type: integer
        vers:
          type: string
    DiagPriorBackupInfo:
      type: object
      properties:
        backups:
          type: array
          items:
            $ref: '#/components/schemas/DiagBackupInfo'
    DiagBackupDiff:
      type: object
      properties:
        diff:
          type: string
    DiagRestorePriorBackupRequst:
      type: object
      properties:
        time:
          type: integer
    ConsoleClients:
      type: object
      properties:
        clients:
          type: array
          items:
            $ref: '#/components/schemas/ConsoleClient'
    ConsoleClient:
      type: object
      properties:
        addr:
          type: string
        type:
          type: string
        time:
          type: integer
    DiagDnsServerTiming:
      type: object
      properties:
        server:
          type: string
        time:
          type: string
    DiagDnsRecord:
      type: object
      properties:
        type:
          type: string
        data:
          type: string
    DiagDnsLookupResult:
      type: object
      properties:
        results:
          type: array
          items:
            $ref: '#/components/schemas/DiagDnsRecord'
        timings:
          type: array
          items:
            $ref: '#/components/schemas/DiagDnsServerTiming'
    DnsAliasRequest:
      type: object
      properties:
        aliasname:
          type: string
        address:
          type: string
    SystemControl:
      type: object
      description: |
        valid values:
        action = "default", "halt", "reboot", "rebootfsck"
      properties:
        action:
          type: string
    LimiterInfo:
      type: object
      properties:
        pipes:
          type: string
          format: byte
        sched:
          type: string
          format: byte
        queues:
          type: string
          format: byte
    DiagLimiters:
      type: object
      properties:
        limiters:
          $ref: '#/components/schemas/LimiterInfo'
    DiagCommandResult:
      type: object
      properties:
        response:
          type: string
    DiagUploadRequest:
      type: object
      properties:
        filename:
          type: string
        contents:
          type: string
          format: byte
    DiagUploadResult:
      type: object
      properties:
        result:
          type: string
        location:
          type: string
    DiagShellCommand:
      type: object
      properties:
        cmd:
          type: string
          format: byte
    DiagPhpCommand:
      type: object
      properties:
        cmd:
          type: string
          format: byte
    DiagPingRequest:
      type: object
      properties:
        host:
          type: string
        count:
          type: integer
    DiagPingResponse:
      type: object
      properties:
        results:
          type: string
    PftopResponse:
      type: object
      properties:
        pftop:
          type: string
          format: byte
    EditFileData:
      type: object
      properties:
        fname:
          type: string
          format: byte
        contents:
          type: string
          format: byte
    PfInfo:
      type: object
      properties:
        info:
          type: string
          format: byte
        memory:
          type: string
          format: byte
        timeouts:
          type: string
          format: byte
        interfaces:
          type: string
          format: byte
    PfInfoResponse:
      type: object
      properties:
        pfinfo:
          $ref: '#/components/schemas/PfInfo'
    RouteRecord:
      type: object
      properties:
        dest:
          type: string
        gw:
          type: string
        flag:
          type: string
        uses:
          type: string
        mtu:
          type: string
        interface:
          type: string
        exp:
          type: string
    DiagRoutes:
      type: object
      properties:
        ipv4:
          type: array
          items:
            $ref: '#/components/schemas/RouteRecord'
        ipv6:
          type: array
          items:
            $ref: '#/components/schemas/RouteRecord'
    PcapInterface:
      type: object
      properties:
        if:
          type: string
        name:
          type: string
    PacketCapture:
      type: object
      properties:
        capture:
          type: string
          format: byte
        starttime:
          type: string
        endtime:
          type: string
        running:
          type: boolean
        interfaces:
          type: array
          items:
            $ref: '#/components/schemas/PcapInterface'
    PacketCaptureRequest:
      type: object
      description: |
        valid values:
        action = "start", "stop"
        proto = "icmp", "icmp6", "tcp" , "udp", "arp", "carp", "esp", "pfsync", "ospf"
        detail = "full", "high", "medium", "normal"
      properties:
        action:
          type: string
        host:
          type: string
        interface:
          type: string
        promiscuous:
          type: boolean
        count:
          type: integer
        snaplen:
          type: integer
        port:
          type: string
        detail:
          type: string
        fam:
          type: string
        proto:
          type: string
        dnsquery:
          type: boolean
    SMARTDevices:
      type: object
      properties:
        drives:
          type: array
          items:
            type: string
    SMARTResult:
      type: object
      properties:
        status:
          type: string
        result:
          type: string
    OsSocket:
      type: object
      properties:
        user:
          type: string
        command:
          type: string
        fd:
          type: string
        pid:
          type: string
        proto:
          type: string
        local:
          type: string
        foreign:
          type: string
    OsSocketList:
      type: object
      properties:
        ipv4:
          type: array
          items:
            $ref: '#/components/schemas/OsSocket'
        ipv6:
          type: array
          items:
            $ref: '#/components/schemas/OsSocket'
    DiagSocketStats:
      type: object
      properties:
        sockets:
          $ref: '#/components/schemas/OsSocketList'
    DiagState:
      type: object
      properties:
        interface:
          type: string
        proto:
          type: string
        src:
          type: string
        dst:
          type: string
        display:
          type: string
        state:
          type: string
        packet:
          type: string
        bytes:
          type: string
    DiagStates:
      type: object
      properties:
        states:
          type: array
          items:
            $ref: '#/components/schemas/DiagState'
        interfaces:
          type: array
          items:
            $ref: '#/components/schemas/SimpleInterface'
    TestPortRequest:
      type: object
      properties:
        host:
          type: string
        src_port:
          type: string
        src_ip:
          type: string
        port:
          type: integer
        show_text:
          type: boolean
        ip_proto:
          type: string
    TestPortResponse:
      type: object
      properties:
        response:
          type: string
    TestPortSources:
      type: object
      properties:
        sources:
          type: string
    TracerouteRequest:
      type: object
      properties:
        host:
          type: string
        hops:
          type: integer
        icmp:
          type: boolean
        proto:
          type: string
        rev:
          type: boolean
        src:
          type: string
    TracerouteResponse:
      type: object
      properties:
        results:
          type: string
    ACBConfig:
      type: object
      description: |
        valid values:
        frequency = "cron", "every"
        reverse = "yes", "no"
      properties:
        encryption_password:
          type: string
        enable:
          type: boolean
        hint:
          type: string
        frequency:
          type: string
        minute:
          type: string
        hour:
          type: string
        month:
          type: string
        day:
          type: string
        dow:
          type: string
        numman:
          type: string
        reverse:
          type: string
    ACBManualBackupRequest:
      type: object
      properties:
        reason:
          type: string
    ACBRestoreRequest:
      type: object
      properties:
        timestamp:
          type: string
    ACBConfigInfo:
      type: object
      properties:
        config:
          $ref: '#/components/schemas/ACBConfig'
        userkey:
          type: string
    ACBBackup:
      type: object
      properties:
        timestamp:
          type: string
        reason:
          type: string
    ACBList:
      type: object
      properties:
        backups:
          type: array
          items:
            $ref: '#/components/schemas/ACBBackup'
    RetrievedBackup:
      type: object
      properties:
        backup:
          type: string
    CaptivePortalConfig:
      type: object
      properties:
        zone:
          type: string
        zoneid:
          type: string
        descr:
          type: string
        localauth_priv:
          type: boolean
        interface:
          type: string
        maxproc:
          type: string
        maxprocperip:
          type: string
        timeout:
          type: string
        idletime:
          type: string
        trafficquota:
          type: string
        freelogins_count:
          type: string
        freelogins_resettimeout:
          type: string
        freelogins_updatetimeouts:
          type: boolean
        logoutwin_enable:
          type: boolean
        enable:
          type: boolean
        auth_method:
          type: string
        auth_server:
          type: string
        auth_server2:
          type: string
        radmac_secret:
          type: string
        radmac_fallback:
          type: boolean
        radiussession_timeout:
          type: boolean
        radiustraffic_quota:
          type: boolean
        radiusperuserbw:
          type: boolean
        radacct_enable:
          type: boolean
        radacct_server:
          type: string
        reverseacct:
          type: boolean
        includeidletime:
          type: boolean
        reauthenticate:
          type: boolean
        preservedb:
          type: boolean
        reauthenticateacct:
          type: string
        httpslogin:
          type: boolean
        httpsname:
          type: string
        preauthurl:
          type: string
        blockedmacsurl:
          type: string
        certref:
          type: string
        nohttpsforwards:
          type: boolean
        nomacfilter:
          type: boolean
        redirurl:
          type: string
        passthrumacadd:
          type: boolean
        radmac_format:
          type: string
        radiusnasid:
          type: string
        customlogo:
          type: boolean
        custombg:
          type: boolean
        customhtml:
          type: boolean
        termsconditions:
          type: string
        page:
          type: string
        noconcurrentlogins:
          type: string
        peruserbw:
          type: boolean
        bwdefaultdn:
          type: string
        bwdefaultup:
          type: string
        passthrumac:
          type: array
          items:
            $ref: '#/components/schemas/PassthruMac'
        allowedip:
          type: array
          items:
            $ref: '#/components/schemas/AllowedIP'
        allowedhostname:
          type: array
          items:
            $ref: '#/components/schemas/AllowedHost'
        element:
          type: array
          items:
            $ref: '#/components/schemas/CaptiveElement'
    PassthruMac:
      type: object
      properties:
        action:
          type: string
        mac:
          type: string
        bw_up:
          type: string
        bw_down:
          type: string
        descr:
          type: string
    AllowedIP:
      type: object
      properties:
        ip:
          type: string
        sn:
          type: string
        descr:
          type: string
        dir:
          type: string
        bw_up:
          type: string
        bw_down:
          type: string
    AllowedHost:
      type: object
      properties:
        hostname:
          type: string
        sn:
          type: string
        descr:
          type: string
        dir:
          type: string
        bw_up:
          type: string
        bw_down:
          type: string
    CaptiveElement:
      type: object
      properties:
        name:
          type: string
        size:
          type: string
        nocontent:
          type: string
    Voucher:
      type: object
      properties:
        charset:
          type: string
        rollbits:
          type: integer
        ticketbits:
          type: integer
        checksumbits:
          type: integer
        magic:
          type: integer
        exponent:
          type: integer
        publickey:
          type: string
        privatekey:
          type: string
        descrmsgnoaccess:
          type: string
        descrmsgexpired:
          type: string
        enable:
          type: boolean
        roll:
          type: array
          items:
            $ref: '#/components/schemas/VoucherRoll'
    VoucherRoll:
      type: object
      properties:
        zone:
          type: string
        number:
          type: integer
        minutes:
          type: integer
        descr:
          type: string
        count:
          type: string
        used:
          type: string
        active:
          type: boolean
        lastsync:
          type: integer
    CaptivePortalName:
      type: object
      properties:
        zone:
          type: string
        interface:
          type: string
        descr:
          type: string
        users:
          type: integer
    CaptivePortalInfo:
      type: object
      properties:
        config:
          $ref: '#/components/schemas/CaptivePortalConfig'
        interfaces:
          type: array
          items:
            type: string
        certificates:
          type: array
          items:
            $ref: '#/components/schemas/ServiceCertificate'
        vouch:
          $ref: '#/components/schemas/Voucher'
    CaptivePortalConfigReq:
      type: object
      properties:
        config:
          $ref: '#/components/schemas/CaptivePortalConfig'
    CaptivePortals:
      type: object
      properties:
        config:
          type: array
          items:
            $ref: '#/components/schemas/CaptivePortalName'
    CaptivePortalUserInfo:
      type: object
      properties:
        ip_address:
          type: string
        mac_address:
          type: string
        mac_manufacturer:
          type: string
        username:
          type: string
        session_id:
          type: string
        session_start_unix:
          type: integer
        session_duration_seconds:
          type: integer
        session_remaining_seconds:
          type: integer
        idle_time_seconds:
          type: integer
        bytes_sent:
          type: integer
        bytes_received:
          type: integer
        packets_sent:
          type: integer
        packets_received:
          type: integer
        last_activity:
          type: integer
        zone:
          type: string
    CaptivePortalStatus:
      type: object
      properties:
        users:
          type: array
          items:
            $ref: '#/components/schemas/CaptivePortalUserInfo'
    CaptivePortalDisconnectRequest:
      type: object
      properties:
        all:
          type: boolean
        session_id:
          type: string
    CARPVIPStatus:
      type: object
      properties:
        interface:
          type: string
        virtual_ip:
          type: string
        virtual_aliases:
          type: array
          items:
            type: string
        mode:
          type: string
        peer:
          type: string
        description:
          type: string
        status:
          type: string
    CARPStatus:
      type: object
      properties:
        enabled:
          type: boolean
        maintenancemode_enabled:
          type: boolean
        vips:
          type: array
          items:
            $ref: '#/components/schemas/CARPVIPStatus'
    CARPResetDemotionResult:
      type: object
      properties:
        carp_detected_problems:
          type: integer
    DHCPLeases:
      type: object
      properties:
        v4leases:
          type: array
          items:
            $ref: '#/components/schemas/DHCPLease'
        v6leases:
          type: array
          items:
            $ref: '#/components/schemas/DHCPLease'
        prefixes:
          type: array
          items:
            $ref: '#/components/schemas/DHCPLease'
        interfaces:
          type: array
          items:
            $ref: '#/components/schemas/LeaseInterface'
    DHCPLease:
      type: object
      properties:
        host:
          type: string
        lifetime:
          type: integer
        ip:
          type: string
        mac:
          type: string
        cltt:
          type: string
        state:
          type: string
        start:
          type: string
        end:
          type: string
        iaid:
          type: integer
        duid:
          type: string
    LeaseInterface:
      type: object
      properties:
        name:
          type: string
        start:
          type: string
        end:
          type: string
        num:
          type: integer
    Dhcpd:
      type: object
      properties:
        lan:
          $ref: '#/components/schemas/DhcpdLan'
    DhcpdLan:
      type: object
      properties:
        text:
          type: string
        enable:
          type: string
        range:
          $ref: '#/components/schemas/DhcpRange'
    DhcpRange:
      type: object
      properties:
        from:
          type: string
        to:
          type: string
    DhcpLeaseIp:
      type: object
      properties:
        ip:
          type: string
    DhcpHighAvailabilityAdvanceConfig:
      type: object
      properties:
        heartbeat_delay:
          type: integer
        max_response_delay:
          type: integer
        max_ack_delay:
          type: integer
        max_unacked_clients:
          type: integer
        max_rejected_updates:
          type: integer
    DhcpHighAvailabilityConfig:
      type: object
      description: High-availability configuration for Kea DHCP service.
      properties:
        enable:
          type: boolean
        role:
          type: string
        local_name:
          type: string
        local_address:
          type: string
        remote_name:
          type: string
        remote_address:
          type: string
        advance_options:
          $ref: '#/components/schemas/DhcpHighAvailabilityAdvanceConfig'
        enable_tls:
          type: boolean
        tls_server_cert_refid:
          type: string
        enable_mutual_tls:
          type: boolean
        mutual_client_cert_refid:
          type: string
        available_tls_server_certs:
          type: array
          items:
            type: string
        available_mutual_client_certs:
          type: array
          items:
            type: string
    DhcpNetworkBooting:
      type: object
      properties:
        enable:
          type: boolean
        next_server:
          type: string
        default_bios_name:
          type: string
        uefi_32_filename:
          type: string
        uefi_64_filename:
          type: string
        arm_32_filename:
          type: string
        arm_64_filename:
          type: string
        uefi_http_boot_url:
          type: string
        root_path:
          type: string
        bootfile_url:
          type: string
    DhcpStaticMapping:
      type: object
      properties:
        id:
          type: string
        mac_address:
          type: string
        client_identifier:
          type: string
        ip_address:
          type: string
        arp_table_static_entry:
          type: boolean
        hostname:
          type: string
        description:
          type: string
        early_dns_reg:
          type: string
        wins_servers:
          type: array
          items:
            type: string
        dns_servers:
          type: array
          items:
            type: string
        gateway:
          type: string
        domain_name:
          type: string
        domain_search_list:
          type: array
          items:
            type: string
        ntp_servers:
          type: array
          items:
            type: string
        tftp_server:
          type: string
        ldap_server_uri:
          type: string
        network_booting:
          $ref: '#/components/schemas/DhcpNetworkBooting'
        duid:
          type: string
        ipv6_address:
          type: string
        filename:
          type: string
        rootpath:
          type: string
    Dhcpv6StaticMapping:
      type: object
      properties:
        id:
          type: string
        backend:
          type: string
        duid:
          type: string
        ipv6_address:
          type: string
        hostname:
          type: string
        description:
          type: string
        early_dns_reg:
          type: string
    DhcpStaticMappings:
      type: object
      properties:
        entries:
          type: array
          items:
            $ref: '#/components/schemas/DhcpStaticMapping'
        entriesv6:
          type: array
          items:
            $ref: '#/components/schemas/Dhcpv6StaticMapping'
    DhcpAddressPool:
      type: object
      properties:
        id:
          type: string
        deny_unknown_clients:
          type: string
        description:
          type: string
        address_pool_range_from:
          type: string
        address_pool_range_to:
          type: string
        wins_servers:
          type: array
          items:
            type: string
        dns_servers:
          type: array
          items:
            type: string
        gateway:
          type: string
        domain_name:
          type: string
        domain_search_list:
          type: array
          items:
            type: string
        mac_allow:
          type: array
          items:
            type: string
        mac_deny:
          type: array
          items:
            type: string
        ntp_servers:
          type: array
          items:
            type: string
        tftp_server:
          type: string
        ldap_server_uri:
          type: string
        network_booting:
          $ref: '#/components/schemas/DhcpNetworkBooting'
        subnet:
          type: string
        subnet_range_from:
          type: string
        subnet_range_to:
          type: string
    DhcpAddressPools:
      type: object
      properties:
        entries:
          type: array
          items:
            $ref: '#/components/schemas/DhcpAddressPool'
    DhcpInterfaceConfig:
      type: object
      properties:
        if_ident:
          type: string
        if_assigned_name:
          type: string
        enabled:
          type: boolean
        deny_unknown_clients:
          type: string
        ignore_client_identifiers:
          type: boolean
        dns_reg:
          type: string
        early_dns_reg:
          type: string
        address_pool_range_from:
          type: string
        address_pool_range_to:
          type: string
        wins_servers:
          type: array
          items:
            type: string
        dns_servers:
          type: array
          items:
            type: string
        additional_pools:
          type: array
          items:
            $ref: '#/components/schemas/DhcpAddressPool'
        gateway:
          type: string
        domain_name:
          type: string
        domain_search_list:
          type: array
          items:
            type: string
        default_lease_time:
          type: integer
        maximum_lease_time:
          type: integer
        mac_allow:
          type: array
          items:
            type: string
        mac_deny:
          type: array
          items:
            type: string
        ntp_servers:
          type: array
          items:
            type: string
        tftp_server:
          type: string
        ldap_server_uri:
          type: string
        network_booting:
          $ref: '#/components/schemas/DhcpNetworkBooting'
        static_mappings:
          type: array
          items:
            $ref: '#/components/schemas/DhcpStaticMapping'
        static_mappings_v6:
          type: array
          items:
            $ref: '#/components/schemas/Dhcpv6StaticMapping'
        subnet:
          type: string
        subnet_range_from:
          type: string
        subnet_range_to:
          type: string
        backend:
          type: string
    DhcpGlobalSettings:
      type: object
      properties:
        backend:
          type: string
        radvd_debug:
          type: boolean
        dhcp6_debug:
          type: boolean
        address_release:
          type: boolean
        ipv6_duid_type:
          type: string
          description: |
            A DHCPv6 Unique Identifier (DUID) is used by the firewall when requesting an IPv6 address.
            
            By default, the firewall automatically creates a dynamic DUID-LLT which is not saved
            in the firewall configuration. To ensure that the same DUID is retained by the firewall
            at all times, enter a DUID in this section. The new DUID will take effect after a
            reboot or when the WAN interface(s) are reconfigured by the firewall.
            
            If the firewall is configured to use a RAM disk for state (such as /var), the best
            practice is to store a DUID here; otherwise, the DUID will change on each reboot.
            
            When setting the config, if duid type is 0/raw and no value for ipv6_duid_raw is provided,
            then the DUID will be removed from the firewall configuration.
          format: str
          enum: ['0', '1', '2', '3', '4', 'raw', 'llt', 'en', 'll', 'uuid']
        ipv6_duid_raw:
          type: string
        ipv6_duid_llt_time:
          type: string
        ipv6_duid_llt_ll:
          type: string
        ipv6_duid_en_en:
          type: string
        ipv6_duid_en_id:
          type: string
        ipv6_duid_ll:
          type: string
        ipv6_duid_uuid:
          type: string
    DhcpServiceConfig:
      type: object
      description: Per IP version DHCP service setting
      properties:
        high_availability:
          $ref: '#/components/schemas/DhcpHighAvailabilityConfig'
        dns_reg:
          type: boolean
        early_dns_reg:
          type: boolean
        interfaces:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/DhcpInterfaceConfig'
    DhcpdConfig:
      type: object
      properties:
        service:
          $ref: '#/components/schemas/DhcpGlobalSettings'
        dhcpd:
          $ref: '#/components/schemas/DhcpServiceConfig'
        dhcpdv6:
          $ref: '#/components/schemas/DhcpServiceConfig'
    InterfaceLabelToName:
      type: object
      description: |
        Mapping of friendly interface label to the configuration name
        and the underlying device name. For example:
        
        friendly: LANOPT
        name:     lanopt (assigned)
        ident:    opt1
        if:       eth0
      properties:
        friendly:
          type: string
        name:
          type: string
        ident:
          type: string
        if:
          type: string
    DhcpInterfaces:
      type: object
      properties:
        entries:
          type: array
          items:
            $ref: '#/components/schemas/InterfaceLabelToName'
    DhcpRelayConfig:
      type: object
      properties:
        enable:
          type: boolean
        interfaces:
          type: array
          items:
            type: string
        carp_status_vip:
          type: string
        append_circuit_agent_ids:
          type: boolean
        upstream_servers:
          type: array
          items:
            type: string
    DhcpRelayToggle:
      type: object
      properties:
        enable:
          type: boolean
    DNSForwarderHost:
      type: object
      properties:
        host:
          type: string
        domain:
          type: string
        ip:
          type: string
        descr:
          type: string
        aliases:
          type: array
          items:
            $ref: '#/components/schemas/DNSForwarderAlias'
    DNSForwarderAlias:
      type: object
      properties:
        host:
          type: string
        domain:
          type: string
        description:
          type: string
    DNSForwarderDomain:
      type: object
      properties:
        domain:
          type: string
        ip:
          type: string
        descr:
          type: string
        idx:
          type: integer
    DNSResolverStatus:
      type: object
      properties:
        speed:
          type: array
          items:
            $ref: '#/components/schemas/DNSResolverStatusSpeed'
        stats:
          type: array
          items:
            $ref: '#/components/schemas/DNSResolverStatusStats'
    DNSResolverStatusSpeed:
      type: object
      properties:
        server:
          type: string
        zone:
          type: string
        ttl:
          type: integer
        expired:
          type: boolean
        ping:
          type: integer
        var:
          type: integer
        rtt:
          type: integer
        rto:
          type: integer
        timeout_a:
          type: integer
        timeout_aaaa:
          type: integer
        timeout_other:
          type: integer
    DNSResolverStatusStats:
      type: object
      properties:
        server:
          type: string
        zone:
          type: string
        expired:
          type: boolean
        edns_lame_known:
          type: integer
        edns_version:
          type: integer
        probe_delay:
          type: integer
        lame_dnssec:
          type: integer
        lame_rec:
          type: integer
        lame_a:
          type: integer
        lame_other:
          type: integer
    DNSResolverConfig:
      type: object
      properties:
        enable:
          type: boolean
        dnssec:
          type: boolean
        active_interface:
          type: string
        outgoing_interface:
          type: string
        custom_options:
          type: string
          format: byte
        hideidentity:
          type: boolean
        hideversion:
          type: boolean
        dnssecstripped:
          type: boolean
        qname_minimisation:
          type: boolean
        qname_minimisation_strict:
          type: boolean
        prefetch:
          type: boolean
        prefetchkey:
          type: boolean
        dnsrecordcache:
          type: boolean
        aggressivensec:
          type: boolean
        msgcachesize:
          type: string
        outgoing_num_tcp:
          type: string
        incoming_num_tcp:
          type: string
        edns_buffer_size:
          type: string
        num_queries_per_thread:
          type: string
        jostle_timeout:
          type: string
        cache_max_ttl:
          type: string
        cache_min_ttl:
          type: string
        infra_host_ttl:
          type: string
        infra_cache_numhosts:
          type: string
        unwanted_reply_threshold:
          type: string
        log_verbosity:
          type: string
        disable_auto_added_access_control:
          type: boolean
        disable_auto_added_host_entries:
          type: boolean
        use_caps:
          type: boolean
        dns64:
          type: boolean
        dns64prefix:
          type: string
        dns64netbits:
          type: string
        port:
          type: integer
        sslport:
          type: integer
        sslcertref:
          type: string
        system_domain_local_zone_type:
          type: string
        regdhcp:
          type: boolean
        enablessl:
          type: boolean
        python:
          type: boolean
        python_order:
          type: string
        python_script:
          type: string
        forwarding:
          type: boolean
        forward_tls_upstream:
          type: boolean
        regdhcpstatic:
          type: boolean
        regovpnclients:
          type: boolean
        hosts:
          type: array
          items:
            $ref: '#/components/schemas/DNSForwarderHost'
        domainoverrides:
          type: array
          items:
            $ref: '#/components/schemas/DNSForwarderDomain'
        acls:
          type: array
          items:
            $ref: '#/components/schemas/DNSACL'
    DNSACL:
      type: object
      properties:
        aclid:
          type: string
        aclname:
          type: string
        aclaction:
          type: string
        description:
          type: string
        row:
          type: array
          items:
            $ref: '#/components/schemas/DNSACLNetwork'
    DNSACLNetwork:
      type: object
      properties:
        acl_network:
          type: string
        mask:
          type: string
        description:
          type: string
    DNSResolverConfigInfo:
      type: object
      properties:
        config:
          $ref: '#/components/schemas/DNSResolverConfig'
        interfaces:
          type: array
          items:
            type: string
        certs:
          type: array
          items:
            $ref: '#/components/schemas/ServiceCertificate'
        scripts:
          type: array
          items:
            type: string
    DNSResolverUpdateReq:
      type: object
      properties:
        config:
          $ref: '#/components/schemas/DNSResolverConfig'
    DNSForwarderConfig:
      type: object
      properties:
        enable:
          type: boolean
        regdhcp:
          type: boolean
        regdhcpstatic:
          type: boolean
        dhcpfirst:
          type: boolean
        strict_order:
          type: boolean
        domain_needed:
          type: boolean
        no_private_reverse:
          type: boolean
        port:
          type: integer
        interface:
          type: string
        strictbind:
          type: boolean
        custom_options:
          type: string
          format: byte
        hosts:
          type: array
          items:
            $ref: '#/components/schemas/DNSForwarderHost'
        domainoverrides:
          type: array
          items:
            $ref: '#/components/schemas/DNSForwarderDomain'
    DNSForwarderConfigInfo:
      type: object
      properties:
        config:
          $ref: '#/components/schemas/DNSForwarderConfig'
        interfaces:
          type: array
          items:
            type: string
    DNSForwarderUpdateReq:
      type: object
      properties:
        config:
          $ref: '#/components/schemas/DNSForwarderConfig'
    DynDNSConfigs:
      type: object
      properties:
        dyndnses:
          type: array
          items:
            $ref: '#/components/schemas/DynDNSConfig'
        dnsupdate:
          type: array
          items:
            $ref: '#/components/schemas/RFCItem'
        checkipservice:
          type: array
          items:
            $ref: '#/components/schemas/CheckIPService'
    DynDNSConfig:
      type: object
      properties:
        type:
          type: string
        username:
          type: string
        password:
          type: string
        host:
          type: string
        domainname:
          type: string
        mx:
          type: integer
        wildcard:
          type: boolean
        verboselog:
          type: boolean
        curl_ipresolve_v4:
          type: boolean
        curl_ssl_verifypeer:
          type: boolean
        enable:
          type: boolean
        interface:
          type: string
        zoneid:
          type: string
        ttl:
          type: string
        updateurl:
          type: string
        resultmatch:
          type: string
        requestif:
          type: string
        proxied:
          type: boolean
        descr:
          type: string
        id:
          type: string
        ip:
          type: string
    RFCItem:
      type: object
      properties:
        enable:
          type: boolean
        host:
          type: string
        zone:
          type: string
        ttl:
          type: string
        keyname:
          type: string
        keyalgorithm:
          type: string
        keydata:
          type: string
        server:
          type: string
        usetcp:
          type: boolean
        usepublicip:
          type: boolean
        recordtype:
          type: string
        interface:
          type: string
        updatesource:
          type: string
        updatesourcefamily:
          type: string
        descr:
          type: string
        ipv4:
          type: string
        ipv6:
          type: string
    CheckIPService:
      type: object
      properties:
        enable:
          type: boolean
        name:
          type: string
        url:
          type: string
        username:
          type: string
        password:
          type: string
        verifysslpeer:
          type: boolean
        descr:
          type: string
    DynDNSUpdateReq:
      type: object
      properties:
        config:
          $ref: '#/components/schemas/DynDNSConfigs'
    DynDNSConfigInfo:
      type: object
      properties:
        config:
          $ref: '#/components/schemas/DynDNSConfigs'
        interfaces:
          type: array
          items:
            type: string
    IGMPProxySettings:
      type: object
      properties:
        verbose:
          type: boolean
        enable:
          type: boolean
    IGMPProxies:
      type: object
      properties:
        igmpentry:
          type: array
          items:
            $ref: '#/components/schemas/IGMPProxy'
        enable:
          type: boolean
        verbose:
          type: boolean
        interfaces:
          type: string
    IGMPProxiesReq:
      type: object
      properties:
        igmpentry:
          type: array
          items:
            $ref: '#/components/schemas/IGMPProxy'
    UpdateProxyReq:
      type: object
      properties:
        proxy:
          $ref: '#/components/schemas/IGMPProxy'
    IGMPProxy:
      type: object
      properties:
        ifname:
          type: string
        threshold:
          type: string
        descr:
          type: string
        type:
          type: string
        address:
          type: string
    NDPTable:
      type: object
      properties:
        ndptable:
          type: array
          items:
            $ref: '#/components/schemas/NDPEntry'
    NDPEntry:
      type: object
      properties:
        ipv6:
          type: string
        mac:
          type: string
        iface:
          type: string
        hostname:
          type: string
        exp:
          type: string
        status:
          type: string
        flags:
          type: string
    PPPoEServer:
      type: object
      properties:
        remoteip:
          type: string
        localip:
          type: string
        mode:
          type: string
        interface:
          type: string
        n_pppoe_units:
          type: string
        n_pppoe_maxlogin:
          type: string
        pppoe_subnet:
          type: string
        descr:
          type: string
        radius:
          $ref: '#/components/schemas/Radius'
        dns1:
          type: string
        dns2:
          type: string
        pppoeid:
          type: string
        username:
          type: string
    Radius:
      type: object
      properties:
        nasip:
          type: string
        acct_update:
          type: string
        server:
          $ref: '#/components/schemas/RadiusServer'
        server2:
          $ref: '#/components/schemas/RadiusServer'
        accounting:
          type: boolean
        radiusissueips:
          type: boolean
    RadiusServer:
      type: object
      properties:
        ip:
          type: string
        secret:
          type: string
        port:
          type: string
        acctport:
          type: string
        enable:
          type: boolean
    PPPoEConfig:
      type: object
      properties:
        pppoe:
          type: array
          items:
            $ref: '#/components/schemas/PPPoEServer'
        interfaces:
          type: array
          items:
            type: string
    PPPoEConfigReq:
      type: object
      properties:
        pppoe:
          type: array
          items:
            $ref: '#/components/schemas/PPPoEServer'
    SNMPConfig:
      type: object
      properties:
        syslocation:
          type: string
        syscontact:
          type: string
        rocommunity:
          type: string
        modules:
          $ref: '#/components/schemas/SNMPModules'
        enable:
          type: boolean
        pollport:
          type: string
        trapenable:
          type: boolean
        trapserver:
          type: string
        trapserverport:
          type: string
        trapstring:
          type: string
        bindip:
          type: string
    SNMPModules:
      type: object
      properties:
        mibii:
          type: boolean
        netgraph:
          type: boolean
        pf:
          type: boolean
        hostres:
          type: boolean
        ucd:
          type: boolean
        regex:
          type: boolean
    SNMPInterface:
      type: object
      properties:
        text:
          type: string
        value:
          type: string
    ServicesSNMPConfig:
      type: object
      properties:
        config:
          $ref: '#/components/schemas/SNMPConfig'
        interfaces:
          type: array
          items:
            $ref: '#/components/schemas/SNMPInterface'
    ServicesSNMPConfigReq:
      type: object
      properties:
        config:
          $ref: '#/components/schemas/SNMPConfig'
    ToggleUPNP:
      type: object
      properties:
        enable:
          type: boolean
    CreateUPnPACL:
      type: object
      properties:
        permuser:
          type: string
    UPnPPermUser:
      type: object
      properties:
        id:
          type: string
        permuser:
          type: string
    UPnPConfig:
      type: object
      properties:
        enable:
          type: boolean
        enable_upnp:
          type: boolean
        enable_natpmp:
          type: boolean
        ext_iface:
          type: string
        iface_array:
          type: array
          items:
            type: string
        download:
          type: string
        upload:
          type: string
        overridewanip:
          type: string
        upnpqueue:
          type: string
        logpackets:
          type: boolean
        sysuptime:
          type: boolean
        permdefault:
          type: boolean
        row:
          type: array
          items:
            $ref: '#/components/schemas/UPnPPermUser'
        presentationurl:
          type: string
        modelnumber:
          type: string
        enable_stun:
          type: boolean
        stun_host:
          type: string
        stun_port:
          type: string
    ServicesUPnPConfigReq:
      type: object
      properties:
        config:
          $ref: '#/components/schemas/UPnPConfig'
    ServicesUPnPConfig:
      type: object
      properties:
        config:
          $ref: '#/components/schemas/UPnPConfig'
        interfaces:
          type: array
          items:
            type: string
    UPnPMapping:
      type: object
      properties:
        ext_interface:
          type: string
        ext_port:
          type: string
        int_ip:
          type: string
        int_port:
          type: string
        proto:
          type: string
        source_ip:
          type: string
        source_port:
          type: string
        desc:
          type: string
    UPnPMappings:
      type: object
      properties:
        mappings:
          type: array
          items:
            $ref: '#/components/schemas/UPnPMapping'
    NtpServer:
      type: object
      properties:
        addr:
          type: string
        type:
          type: string
        prefer:
          type: boolean
        no_select:
          type: boolean
    LogStats:
      type: object
      properties:
        clock_statistics:
          type: boolean
        discipline_statistics:
          type: boolean
        peer_statistics:
          type: boolean
    NtpSettings:
      type: object
      properties:
        enable:
          type: boolean
        interfaces:
          type: array
          items:
            type: string
        servers:
          type: array
          items:
            $ref: '#/components/schemas/NtpServer'
        ntpmaxpeers:
          type: string
        orphan:
          type: string
        ntpminpoll:
          type: string
        ntpmaxpoll:
          type: string
        statsgraph:
          type: boolean
        logpeer:
          type: boolean
        logsys:
          type: boolean
        log_stats:
          $ref: '#/components/schemas/LogStats'
        leapsec:
          type: string
          format: byte
        dnsresolv:
          type: string
        serverauth:
          type: boolean
        serverauthkey:
          type: string
          format: byte
        serverauthalgo:
          type: string
    NtpAccessRestrictions:
      type: object
      properties:
        kod:
          type: boolean
        nomodify:
          type: boolean
        noquery:
          type: boolean
        noserve:
          type: boolean
        nopeer:
          type: boolean
        notrap:
          type: boolean
    NtpNetworkAccessRestriction:
      type: object
      properties:
        network:
          type: string
        mask:
          type: integer
        restrictions:
          $ref: '#/components/schemas/NtpAccessRestrictions'
    NtpAcls:
      type: object
      properties:
        default_restrictions:
          $ref: '#/components/schemas/NtpAccessRestrictions'
        custom_restrictions:
          type: array
          items:
            $ref: '#/components/schemas/NtpNetworkAccessRestriction'
    NtpGpsFlags:
      type: object
      properties:
        prefer_this_clock:
          type: boolean
        do_not_select_this_clock:
          type: boolean
        enable_pps_signal_processing:
          type: boolean
        enable_falling_edge_pps_signal_processing:
          type: boolean
        enable_kernel_pps_clock_disciple:
          type: boolean
        obscure_location_in_timestamp:
          type: boolean
        log_subsecond_received_timestamp:
          type: boolean
        display_extended_gps_status:
          type: boolean
    NtpSerialGps:
      type: object
      properties:
        type:
          type: string
        port:
          type: string
        speed:
          type: string
        autobaudinit:
          type: boolean
        nmea:
          type: integer
        fudge1:
          type: number
          format: float
        fudge2:
          type: number
          format: float
        stratum:
          type: integer
        gpsminpoll:
          type: string
        gpsmaxpoll:
          type: string
        ntp_gps_flags:
          $ref: '#/components/schemas/NtpGpsFlags'
        refid:
          type: string
        initcmd:
          type: string
          format: byte
        autocorrect_initcmd:
          type: boolean
    NtpPpsFlags:
      type: object
      properties:
        enable_falling_edge_pps_signal_processing:
          type: boolean
        enable_kernel_pps_clock_disciple:
          type: boolean
        record_a_timestamp_once_for_each_second:
          type: boolean
    NtpPps:
      type: object
      properties:
        port:
          type: string
        fudge1:
          type: number
          format: float
        stratum:
          type: integer
        ppsminpoll:
          type: string
        ppsmaxpoll:
          type: string
        pps_flags:
          $ref: '#/components/schemas/NtpPpsFlags'
        refid:
          type: string
    ServicesNtpConfig:
      type: object
      properties:
        settings:
          $ref: '#/components/schemas/NtpSettings'
        acls:
          $ref: '#/components/schemas/NtpAcls'
        serial_gps:
          $ref: '#/components/schemas/NtpSerialGps'
        pps:
          $ref: '#/components/schemas/NtpPps'
    NtpStatus:
      type: object
      properties:
        enabled:
          type: boolean
        query_enabled:
          type: boolean
        servers:
          type: array
          items:
            $ref: '#/components/schemas/NtpServerInfo'
    NtpServerInfo:
      type: object
      properties:
        status:
          type: string
        server:
          type: string
        refid:
          type: string
        stratum:
          type: string
        type:
          type: string
        when:
          type: string
        poll:
          type: string
        reach:
          type: string
        delay:
          type: string
        offset:
          type: string
        jitter:
          type: string
    ServicesStatus:
      type: object
      properties:
        name:
          type: string
        description:
          type: string
        enabled:
          type: boolean
        status:
          type: boolean
    ServicesStatusList:
      type: object
      properties:
        services:
          type: array
          items:
            $ref: '#/components/schemas/ServicesStatus'
    ServicesActionParams:
      type: object
      description: |
        valid values:
        action = "start", "stop", "restart"
      properties:
        service:
          type: string
        action:
          type: string
        vpnid:
          type: string
        mode:
          type: string
        zone:
          type: string
    ServicesActionReq:
      type: object
      properties:
        params:
          $ref: '#/components/schemas/ServicesActionParams'
    ServiceCertificate:
      type: object
      properties:
        name:
          type: string
        ident:
          type: string
    StatusSummary:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/SystemStatus'
    SystemStatus:
      type: object
      properties:
        prod:
          type: string
        host:
          type: string
        osver:
          type: string
        os:
          type: string
        machine:
          type: string
        arch:
          type: string
        vndr:
          type: string
        cores:
          type: integer
        cpu:
          type: string
        up:
          type: string
        rev:
          type: string
        ram:
          type: integer
        fram:
          type: integer
        swap:
          type: integer
        fswap:
          type: integer
        timestamp:
          type: string
        apiver:
          type: string
    IfStatsSummary:
      type: object
      properties:
        if:
          type: string
        ifstats:
          $ref: '#/components/schemas/IfStats'
        bandwidth:
          type: array
          items:
            $ref: '#/components/schemas/IfStatsBandwidth'
    IfStats:
      type: object
      properties:
        time:
          type: integer
        bytesin:
          type: integer
        bytesout:
          type: integer
    IfStatsBandwidth:
      type: object
      properties:
        host:
          type: string
        bitsin:
          type: string
        bitsout:
          type: string
    StdLog:
      type: object
      properties:
        time:
          type: string
        proc:
          type: string
        pid:
          type: string
        msg:
          type: string
    FilterLogVersion4Info:
      type: object
      properties:
        tos:
          type: string
        ecn:
          type: string
        ttl:
          type: string
        id:
          type: string
        offset:
          type: string
        flags:
          type: string
    FilterLogVersion6Info:
      type: object
      properties:
        class:
          type: string
        flow_label:
          type: string
        hlim:
          type: string
    FilterLogTCPInfo:
      type: object
      description: proto_id = 6
      properties:
        tcp_flags:
          type: string
        seq:
          type: string
        ack:
          type: integer
        window:
          type: integer
        urg:
          type: integer
        options:
          type: string
    FilterLogICMPInfo:
      type: object
      description: proto_id 1, 58
      properties:
        icmp_type:
          type: string
        icmp_id:
          type: integer
        icmp_seq:
          type: integer
        icmp_dstip:
          type: string
        icmp_proto_id:
          type: integer
        icmp_port:
          type: integer
        icmp_descr:
          type: string
        icmp_mtu:
          type: integer
        icmp_otime:
          type: string
        icmp_rtime:
          type: string
        icmp_ttime:
          type: string
    FilterLogCARPInfo:
      type: object
      properties:
        type:
          type: string
        ttl:
          type: integer
        vhid:
          type: integer
        version:
          type: integer
        adv_skew:
          type: integer
        adv_base:
          type: integer
    FilterLog:
      type: object
      properties:
        time_usec:
          type: integer
        time:
          type: string
        rulenum:
          type: integer
        subrulenum:
          type: integer
        anchor:
          type: string
        rule_descr:
          type: string
        tracker:
          type: string
        realint:
          type: string
        friendly_interface:
          type: string
        reason:
          type: string
        action:
          type: string
        direction:
          type: string
        version:
          type: integer
        proto_id:
          type: integer
        proto:
          type: string
        v4info:
          $ref: '#/components/schemas/FilterLogVersion4Info'
        v6info:
          $ref: '#/components/schemas/FilterLogVersion6Info'
        length:
          type: integer
        src:
          type: string
        dst:
          type: string
        src_ip:
          type: string
        dst_ip:
          type: string
        src_port:
          type: integer
        dst_port:
          type: integer
        tcp_info:
          $ref: '#/components/schemas/FilterLogTCPInfo'
        icmp_info:
          $ref: '#/components/schemas/FilterLogICMPInfo'
        carp_info:
          $ref: '#/components/schemas/FilterLogCARPInfo'
    FilterLogSummary:
      type: object
      description: Summary of filter log entries. These are dictionaries of keys to counts
      properties:
        total_records:
          type: integer
        actions:
          type: object
          additionalProperties:
            type: integer
        interfaces:
          type: object
          additionalProperties:
            type: integer
        protocols:
          type: object
          additionalProperties:
            type: integer
        src_ips:
          type: object
          additionalProperties:
            type: integer
        dest_ips:
          type: object
          additionalProperties:
            type: integer
        src_ports:
          type: object
          additionalProperties:
            type: integer
        dest_ports:
          type: object
          additionalProperties:
            type: integer
        tracker_hits:
          type: object
          additionalProperties:
            type: integer
    StdLogs:
      type: object
      properties:
        logfile:
          type: string
        logs:
          type: array
          items:
            $ref: '#/components/schemas/StdLog'
        filter_logs:
          type: array
          items:
            $ref: '#/components/schemas/FilterLog'
        filter_summary:
          $ref: '#/components/schemas/FilterLogSummary'
        alerts:
          $ref: '#/components/schemas/Result'
    SyslogConfiguration:
      type: object
      properties:
        reverse:
          type: boolean
        nentries:
          type: integer
        logfilesize:
          type: integer
        logcompressiontype:
          type: string
        format:
          type: string
        rotatecount:
          type: integer
        remoteserver:
          type: string
        remoteserver2:
          type: string
        remoteserver3:
          type: string
        sourceip:
          type: string
        ipproto:
          type: string
        filter:
          type: boolean
        dhcp:
          type: boolean
        auth:
          type: boolean
        portalauth:
          type: boolean
        vpn:
          type: boolean
        dpinger:
          type: boolean
        hostapd:
          type: boolean
        logall:
          type: boolean
        system:
          type: boolean
        pfnet_controller:
          type: boolean
        resolver:
          type: boolean
        ppp:
          type: boolean
        routing:
          type: boolean
        ntpd:
          type: boolean
        disablelocallogging:
          type: boolean
        logconfigchanges:
          type: boolean
        enable:
          type: boolean
        logdefaultblock:
          type: boolean
        logdefaultpass:
          type: boolean
        logbogons:
          type: boolean
        logprivatenets:
          type: boolean
        lognginx:
          type: boolean
        rawfilter:
          type: boolean
        filterdescriptions:
          type: integer
    SyslogConfigOverride:
      type: object
      properties:
        override_reverse:
          type: boolean
        reverse:
          type: boolean
        override_nentries:
          type: boolean
        nentries:
          type: integer
        override_logfilesize:
          type: boolean
        logfilesize:
          type: integer
        override_rotatecount:
          type: boolean
        rotatecount:
          type: integer
        override_format:
          type: boolean
        format:
          type: string
        web_server_log:
          type: boolean
        logdefaultblock:
          type: boolean
        logdefaultpass:
          type: boolean
        logbogons:
          type: boolean
        logprivatenets:
          type: boolean
        filterdescriptions:
          type: integer
    InterfacesWidget:
      type: object
      properties:
        name:
          type: string
        ip:
          type: string
        status:
          type: string
        speed:
          type: string
    InterfaceWidgets:
      type: object
      properties:
        interfaces:
          type: array
          items:
            $ref: '#/components/schemas/InterfacesWidget'
    IPSecWidget:
      type: object
      properties:
        phase1s_active:
          type: integer
        phase1s_total:
          type: integer
        phase2s_active:
          type: integer
        phase2s_total:
          type: integer
        total_active:
          type: integer
        total_inactive:
          type: integer
        mobile_users:
          type: integer
        mobile_active:
          type: integer
        mobile_total:
          type: integer
        tunnels:
          type: array
          items:
            $ref: '#/components/schemas/IPSecWidgetTunnel'
        mobile:
          type: array
          items:
            $ref: '#/components/schemas/IPSecWidgetMobile'
    InterfaceStatisticsWidgetResult:
      type: object
      properties:
        interfaces:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/InterfaceStatisticsWidget'
    IPSecWidgetTunnel:
      type: object
      properties:
        source:
          type: string
        destination:
          type: string
        description:
          type: string
        status:
          type: string
    IPSecWidgetMobile:
      type: object
      properties:
        user:
          type: string
        ip:
          type: string
        status:
          type: string
    InterfaceStatisticsWidget:
      type: object
      properties:
        packets_in:
          type: integer
        packets_out:
          type: integer
        bytes_in:
          type: integer
        bytes_out:
          type: integer
        errors_in:
          type: integer
        errors_out:
          type: integer
        collisions:
          type: integer
    UIStates:
      type: object
      additionalProperties:
        type: boolean
    DeviceNetworkPort:
      type: object
      description: network interface on the device
      properties:
        name:
          type: string
        identity:
          type: string
        device:
          type: string
        assigned:
          type: string
        link_speed:
          type: integer
        phy_speed:
          type: integer
        state:
          type: string
        vlan:
          type: integer
        device_info:
          type: string
        is_physical:
          type: boolean
        addresses:
          type: array
          items:
            type: string
        label:
          type: string
    UpdateCaCertReq:
      type: object
      description: |
        Request for creating a new CA cert or updating an existing one.
        - name: short description about certificate
        - trust: add to OS trusted cert store
        - randomize_serial: use random serial numbers when signing certificates
        - one of: method_internal (self-signed), mehod_existing (import), or method_intermediate (signed by another CA)
      properties:
        name:
          type: string
        trust:
          type: boolean
        randomize_serial:
          type: boolean
        method_internal:
          $ref: '#/components/schemas/CaCertMethodNew'
        method_existing:
          $ref: '#/components/schemas/CaCertMethodExisting'
        method_intermediate:
          $ref: '#/components/schemas/CaCertMethodNew'