> ## Documentation Index
> Fetch the complete documentation index at: https://docs.marcus.involvecloud.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List firmware versions

> The fleet's firmware: one row per make, model and firmware version, with how many devices run it and how it compares with the target set on the Firmware page. Use `firmware_status=differs_from_target` for what needs updating, then `GET /pub/v1/devices?firmware_status=differs_from_target` for the devices themselves. Requires the `view.firmware` scope.

Updated 27 Oct 2026 12:07 · page 307a477


## OpenAPI

````yaml api-reference/openapi.json GET /pub/v1/firmware
openapi: 3.1.0
info:
  title: M.A.R.C.U.S. Public API
  version: 1.0.0
  summary: Programmatic access to a customer's AV fleet.
  description: >-
    Read-only integration API for the M.A.R.C.U.S. monitoring platform. Use it
    to sync device inventory into a CMDB, mirror alerts into an incident tool,
    or feed dashboards with live fleet state. Every route is scoped to the
    token's tenant — one token, one customer's data.


    Polling once a minute is ample for most use cases. Cursor-based pagination
    keeps list endpoints stable under concurrent inserts.
servers:
  - url: https://api.uat.involvecloud.com
    description: UAT
  - url: https://api.involvecloud.com
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Meta
    description: Health and identity of the calling token.
  - name: Devices
    description: >-
      AV endpoints under management — displays, cameras, DSPs, control
      processors.
  - name: Firmware
    description: >-
      Firmware versions across the fleet, against the targets set on the
      Firmware page. Needs the view.firmware scope.
  - name: Hierarchy
    description: 'Physical structure: buildings and rooms.'
  - name: Assets
    description: >-
      The CMDB inventory — every physical thing the tenant owns, monitored or
      not. Broader than Devices: includes mounts, cables, spares, retired gear.
  - name: Alerts
    description: Open + historical incidents raised on devices and collectors.
  - name: Events
    description: Device-emitted events — state changes, adapter messages, telemetry deltas.
  - name: Audit
    description: >-
      The tenant's audit trail of changes and commands. Needs the view.audit
      scope.
  - name: Room Readiness
    description: >-
      Results of each room's power schedule (switched off at night, on in the
      morning) and readiness checks (a test routine, down to every step). Needs
      the nightly.view scope.
paths:
  /pub/v1/firmware:
    get:
      tags:
        - Firmware
      summary: List firmware versions
      description: >-
        The fleet's firmware: one row per make, model and firmware version, with
        how many devices run it and how it compares with the target set on the
        Firmware page. Use `firmware_status=differs_from_target` for what needs
        updating, then `GET /pub/v1/devices?firmware_status=differs_from_target`
        for the devices themselves. Requires the `view.firmware` scope.
      parameters:
        - $ref: '#/components/parameters/BuildingID'
        - $ref: '#/components/parameters/RoomID'
        - name: firmware_status
          in: query
          description: Only versions with this status against their target.
          schema:
            type: string
            enum:
              - matches_target
              - differs_from_target
              - no_target
              - not_reported
      responses:
        '200':
          description: Firmware versions, by make and model, most used first.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/FirmwareVersion'
        '400':
          description: An unknown firmware_status.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
components:
  parameters:
    BuildingID:
      name: building_id
      in: query
      description: Restrict results to one building.
      schema:
        type: string
        format: uuid
    RoomID:
      name: room_id
      in: query
      description: Restrict results to one room.
      schema:
        type: string
        format: uuid
  schemas:
    FirmwareVersion:
      type: object
      required:
        - make
        - model
        - firmware_version
        - firmware_status
        - device_count
      properties:
        make:
          type: string
          description: Empty when the devices haven't reported one.
        model:
          type: string
        firmware_version:
          type: string
          description: Empty for devices that haven't reported firmware.
        target_firmware_version:
          type: string
          description: The target set for this make and model. Absent when none is set.
        firmware_status:
          type: string
          enum:
            - matches_target
            - differs_from_target
            - no_target
            - not_reported
          description: >-
            How the firmware compares with the target set for the device's make
            and model on the Firmware page: `matches_target`,
            `differs_from_target`, `no_target` (no target set) or `not_reported`
            (the device hasn't reported firmware).
        device_count:
          type: integer
          description: Devices of this make and model on this firmware.
      example:
        make: Sony
        model: FW-65BZ40L
        firmware_version: PKG6.5603.0175
        target_firmware_version: PKG6.6510.0185
        firmware_status: differs_from_target
        device_count: 12
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - message
            - code
          properties:
            message:
              type: string
              description: Human-readable summary. Not intended for parsing.
            code:
              type: string
              enum:
                - bad_request
                - unauthorized
                - forbidden
                - not_found
                - internal_error
                - error
              description: Stable machine-readable identifier.
      example:
        error:
          message: 'token missing scope: view.dashboard'
          code: forbidden
  responses:
    Unauthorized:
      description: Missing, malformed, revoked, or expired bearer token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: Token authenticated but doesn't hold the scope this endpoint requires.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: avb_<prefix>_<secret>
      description: >-
        Mint a token from the portal at Settings → API tokens. Send it as
        `Authorization: Bearer avb_...` on every request. Query-string tokens
        are NOT accepted — the URL ends up in access logs.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.