---
updatedAt: 2026-04-29T00:49:36.000Z
agentTools:
  projectIndex: https://synaccess.readme.io/llms.txt
---

# Get Fleet Firmware Summary

Return fleet-wide firmware posture for all devices visible to the authenticated user, including update availability and per-model rollups.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Cloud.Synaccess",
    "version": "1.3"
  },
  "servers": [
    {
      "url": "https://cloud.synaccess.com"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "apiKey",
        "name": "authorization",
        "in": "header",
        "x-default": "Bearer"
      }
    },
    "schemas": {
      "FirmwareSummaryBucket": {
        "type": "object",
        "properties": {
          "updateAvailable": {
            "type": "integer",
            "format": "int32",
            "description": "Count of devices with a compatible firmware update available."
          },
          "upToDate": {
            "type": "integer",
            "format": "int32",
            "description": "Count of devices already on the latest compatible firmware."
          },
          "inProgress": {
            "type": "integer",
            "format": "int32",
            "description": "Count of devices currently updating or queued to update."
          },
          "notEligible": {
            "type": "integer",
            "format": "int32",
            "description": "Count of devices without a compatible firmware release."
          }
        }
      },
      "FirmwareSummaryByModel": {
        "type": "object",
        "properties": {
          "model": {
            "type": "string",
            "description": "Device model number."
          },
          "total": {
            "type": "integer",
            "format": "int32"
          },
          "updateAvailable": {
            "type": "integer",
            "format": "int32"
          },
          "upToDate": {
            "type": "integer",
            "format": "int32"
          },
          "inProgress": {
            "type": "integer",
            "format": "int32"
          },
          "notEligible": {
            "type": "integer",
            "format": "int32"
          }
        }
      },
      "FirmwareFleetSummary": {
        "type": "object",
        "properties": {
          "total": {
            "type": "integer",
            "format": "int32"
          },
          "online": {
            "type": "integer",
            "format": "int32"
          },
          "offline": {
            "type": "integer",
            "format": "int32"
          },
          "firmware": {
            "$ref": "#/components/schemas/FirmwareSummaryBucket"
          },
          "byModel": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/FirmwareSummaryByModel"
            }
          },
          "lastCalculated": {
            "type": "string",
            "format": "date-time"
          }
        }
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "tags": [
    {
      "name": "Firmware",
      "description": "Firmware catalog and update endpoints."
    }
  ],
  "x-tagGroups": [
    {
      "name": "Devices",
      "tags": [
        "Device Inventory",
        "Device Live Telemetry",
        "Device Logs",
        "Configuration",
        "Firmware"
      ]
    },
    {
      "name": "Power Control",
      "tags": [
        "Outlets",
        "PDU Outlet Groups",
        "Inlets",
        "Banks",
        "Sensors"
      ]
    },
    {
      "name": "Automation",
      "tags": [
        "Events",
        "Actions"
      ]
    },
    {
      "name": "Organization",
      "tags": [
        "Groups"
      ]
    }
  ],
  "paths": {
    "/v2/firmware/summary": {
      "get": {
        "summary": "Get Fleet Firmware Summary",
        "description": "Return fleet-wide firmware posture for all devices visible to the authenticated user, including update availability and per-model rollups.",
        "operationId": "firmware-summary",
        "responses": {
          "200": {
            "description": "Fleet firmware summary",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FirmwareFleetSummary"
                },
                "examples": {
                  "Result": {
                    "value": {
                      "total": 42,
                      "online": 38,
                      "offline": 4,
                      "firmware": {
                        "updateAvailable": 12,
                        "upToDate": 20,
                        "inProgress": 3,
                        "notEligible": 7
                      },
                      "byModel": [
                        {
                          "model": "1001CIE-01-SP1",
                          "total": 16,
                          "updateAvailable": 5,
                          "upToDate": 8,
                          "inProgress": 1,
                          "notEligible": 2
                        }
                      ],
                      "lastCalculated": "2026-04-28T18:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid token"
          }
        },
        "deprecated": false,
        "tags": [
          "Firmware"
        ]
      }
    }
  }
}
```