Query Firmware Version by Firmware Key

Last Updated on : 2024-06-26 09:22:36download

Query the version information about the specified firmware based on the product ID and firmware key on the Tuya Developer Platform. For example, the production firmware, update file, enabling status, type, and unique ID of the firmware version.

API address

GET: /v1.0/iot-03/product/firmware/versions

Request parameter

Parameter name	Type	IN	Required	Description
product_id	String	query	true	The product ID.
firmware_key	String	query	true	The firmware key.

Return parameter

Parameter name	Type	Description
result	List	The list of results.

Description of result

Parameter name	Type	Description
remark	String	The remarks.
files	List	The information about a specified firmware version file.
gmt_modified	Long	The time when it is modified.
firmware_version	String	The firmware version number.
shelf_status	Integer	The enabling status. Valid values: `0`: The firmware is not enabled. `1`: The firmware is enabled. `2`: The firmware is to be disabled soon.
version_type	Integer	The firmware version type. Valid values: `1`: general version. `2`: key version.
firmware_version_id	Long	The firmware version ID.

Description of files

Parameter name	Type	Description
name	String	The name of a specified firmware version file.
full_url	String	The URL of a specified firmware version file.
type	String	The file type. Valid values: `firmware_production_QIO`: QIO production firmware. `firmware_production_DOUT`: DOUT production firmware. `firmware_production`: production firmware. `firmware_upgrade`: update firmware. `firmware_production_SUB`: subsidiary production firmware. `firmware_upgradeDiff`: differential firmware.

Request example

GET: /v1.0/iot-03/product/firmware/versions

{
  "product_id": "***pid",
  "firmware_key": "key****"
}

Error code

For more information, see error code.