Get Firmware by Model Number

Get details about the latest firmware available for an AccessoryAccessory - A unique device within the system. An accessory can be any of type and is represented by a unique Accessory Id. An accessory is linked to an account via an accountId. Within this API, a singular Circle camera is 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 TimestampTimestamp - An ISO8601 based format with everything represented server side as UTC+0 or "zulu" format. Takes the form of YYYY-MM-DDTHH:MM:SSZ - For example: 2015-04-04T00:43:29Z or 2016-05-28T23:12:59Z or 2016-11-04T12:00:00Z formatted string for when the Firmware Account IdAccount Id - A unique non changing value to identify a particular Circle user account. Circle Account Id's are globally unique and are UUID v4 strings. The Account Id is not the same value as the Logitech Account Id found when introspecting an OAuth2 Authentication token. Example: 9385e6f9-70c3-45b2-62e4-ace3d027988a 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