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

# Queue Firmware Update Batch

Evaluate a list of devices, select the latest compatible firmware per eligible device, and queue a staggered batch update. The authenticated user must have admin privileges in the target organization.

# 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": {
      "FirmwareBatchQueueItem": {
        "type": "object",
        "properties": {
          "sn": {
            "type": "integer",
            "format": "int64",
            "description": "Enclosure serial number scheduled for update."
          },
          "targetFw": {
            "type": "string",
            "description": "Latest compatible firmware version chosen for this device."
          }
        }
      },
      "FirmwareBatchRequest": {
        "type": "object",
        "required": [
          "serialNumbers"
        ],
        "properties": {
          "serialNumbers": {
            "type": "array",
            "items": {
              "type": "integer",
              "format": "int64"
            },
            "description": "List of enclosure serial numbers to evaluate for batch firmware upgrade."
          },
          "concurrency": {
            "type": "integer",
            "format": "int32",
            "default": 5,
            "description": "Maximum number of devices to dispatch concurrently."
          },
          "delaySec": {
            "type": "integer",
            "format": "int32",
            "default": 30,
            "description": "Minimum spacing in seconds between dispatched update jobs."
          }
        }
      },
      "FirmwareBatchResponse": {
        "type": "object",
        "properties": {
          "queued": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/FirmwareBatchQueueItem"
            }
          },
          "alreadyLatest": {
            "type": "array",
            "items": {
              "type": "integer",
              "format": "int64"
            }
          },
          "noBuild": {
            "type": "array",
            "items": {
              "type": "integer",
              "format": "int64"
            }
          },
          "notVisible": {
            "type": "array",
            "items": {
              "type": "integer",
              "format": "int64"
            }
          },
          "concurrency": {
            "type": "integer",
            "format": "int32"
          },
          "delaySec": {
            "type": "integer",
            "format": "int32"
          }
        }
      }
    }
  },
  "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/batch": {
      "post": {
        "summary": "Queue Firmware Update Batch",
        "description": "Evaluate a list of devices, select the latest compatible firmware per eligible device, and queue a staggered batch update. The authenticated user must have admin privileges in the target organization.",
        "operationId": "firmware-batch",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/FirmwareBatchRequest"
              },
              "examples": {
                "Request Example": {
                  "value": {
                    "serialNumbers": [
                      1510596,
                      1510597
                    ],
                    "concurrency": 5,
                    "delaySec": 30
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Batch evaluation summary and queued jobs",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FirmwareBatchResponse"
                },
                "examples": {
                  "Result": {
                    "value": {
                      "queued": [
                        {
                          "sn": 1510596,
                          "targetFw": "2.5.111"
                        }
                      ],
                      "alreadyLatest": [
                        1510598
                      ],
                      "noBuild": [],
                      "notVisible": [],
                      "concurrency": 5,
                      "delaySec": 30
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Missing serial numbers or no eligible devices"
          },
          "401": {
            "description": "Missing or invalid token"
          },
          "403": {
            "description": "Caller is not an enterprise admin or admin-privileged user"
          }
        },
        "deprecated": false,
        "tags": [
          "Firmware"
        ]
      }
    }
  }
}
```