Get Firmware by Model Number

Get details about the latest firmware available for an Accessory by model number. Returns a firmware object if firmware update is available. To initiate a firmware upgrade use Start Accessory Action by Id.

Permissions

Requires a Permissions scope of: circle:accessories_manage

Response Body

A JSON object representing a Circle Firmware update if one is available with the following keys:

Name

Type

Description

firmwareId

string

The Firmware Id. Needed by the Start Accessory Action by Id call to initiate a firmware update.

created

string

A Timestamp formatted string for when the Firmware Account Id was created.

length

integer

The length of the firmware file in bytes.

updateRequired

boolean

Specifies whether an accessory with this firmware is required to update immediately. If true the firmware will be installed before the device comes online.

version

string

The human readable version number of the firmware.

Language
Authentication
OAuth2