Run firmware update

Single Device

The following sample request executes a firmware update on the provided device.

Request

POST /ws/v1/firmware_updates/inventory

Payload

{
    "targets": {
        "devices": [
            "00000000-00000000-0040FFFF-FF123456"
        ]
    },
    "version": "17.4.1.7"
}

Single Group

The following sample request executes a firmware update on the provided group.

Request

POST /ws/v1/firmware_updates/inventory

Payload

{
    "targets": {
        "groups": [
            "group1"
        ]
    },
    "version": "17.4.1.7"
}

Request payload

To execute a new firmware update, include the following elements in the body of your POST request:

• targets - Specifies the devices to be updated. If multiple elements are provided, they are combined using an OR operation. This means that if you include both tags and groups, devices that belong to the specified group OR have the specified tag will be updated. They can be specified with the following elements:
  • devices - List with the IDs of the devices to update.
  • tags - List with the tag names the devices to update are labeled with.
  • groups - List with the name of the groups containing the devices to update.
• version - The firmware version to use for the update.
• file - The name of the file from a fileset to use for the update.

Response

{
    "count": 3,
    "size": 1000,
    "list": [
        {
            "device_id": "00000000-00000000-0040FFFF-FF123456",
            "error": "Invalid target. Device not found"
        },
        {
            "device_id": "00000000-00000000-0040FFFF-FF654321",
            "id": 1
        },
        {
            "device_id": "00000000-00000000-0040FFFF-FF112233",
            "id": 2
        }
    ]
}