Update custom firmware

The following sample JSON request updates different parameters of a custom firmware.

Request

PUT /ws/v1/firmware/inventory/{vendor_id}/{device_type}?firmware_version={firmware_version}

Parameters

Name	Type	Mandatory	Description
vendor_id	hex string	Yes	The vendor ID of the firmware (for example: FE00000A).
device_type	string	Yes	The device type of the firmware.
firmware_version	string	Yes	The version of the firmware.
artifact_id	string	No	The artifact ID of the firmware. Do not specify the artifact ID for the main firmware image, that is, the image that will be sent to the device.
device_type_internal	integer	No	The device type internal (hardware version) of the firmware. Only applicable for XBee firmware.

Payload

The following parameters are the only ones that can be updated for existing custom firmware. You can use one or several in the same request.

{
    "production": true,
    "deprecated": false,
    "information_link": "https://www.digi.com",
    "security_related": "not-identified",
    "shared": "1532,1533,1534",
    "download_allowed": "true"
}

Name	Type	Description
production	boolean	`true` to mark the firmware as production, `false` to mark it as non-production.
deprecated	boolean	`true` to mark the firmware as deprecated, `false` to mark it as non-deprecated.
information_link	string	URL of the firmware release notes.
security_related	string	The CVSS score of the firmware: `not-identified`, `none`, `low`, `medium`, `high` or `critical`.
shared	string	A comma-separated list of subaccount customer IDs to share the custom firmware with. It can also be `all` to share the firmware with all subaccounts. If no shared is provided, the firmware is not shared with any subaccount.
download_allowed	boolean	`true` to allow subaccounts to download the firmware, `false` to disallow it. It defaults to `true`. This option is used to restrict the download, not the use to update devices. The firmware must be shared with at least one subaccount to use it.

Response

{
    "location": "https://com-digi-drm-filedata-prod.s3.amazonaws.com/Forever/prdMy/2/firmware/fe080003-DEY.device-5.0.0.0.b1508b02-5158-459b-a4e8-cd9502fd062d?response-content-disposition=attachment%3B%20filename%3D%225.0.0.0.swu%22&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230417T145942Z&X-Amz-SignedHeaders=host&X-Amz-Expires=86399&X-Amz-Credential=AKIAIOSFODNN7EXAMPLE%2F20230417%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=10f99537672f184b53037d63dfdb976c96f38b481fd94d898e8fa95782a80c2f",
    "vendor_id": 4261937155,
    "type": "DEY device",
    "firmware_version": "5.0.0.0",
    "file_size": 45223,
    "production": true,
    "deprecated": false,
    "filename": "DEYdevice-5.0.0.0.bin",
    "information_link": "https://www.digi.com",
    "security_related": "not-identified",
    "sha_512": "861844d6704e8573fec34d967e20bcfef3d424cf48be04e6dc08f2bd58c729743371015ead891cc3cf1c9d34b49264b510751b1ff9e537937bc46b5d6ff4ecc8",
    "sha3_512": "32400b5e89822de254e8d5d94252c52bdcb27a3562ca593e980364d9848b8041b98eabe16c1a6797484941d2376864a1b0e248b0f7af8b1555a778c336a5bf48",
    "firmware_status": "up_to_date",
    "customer_id": 2,
    "shared": "1532,1533,1534",
    "download_allowed": "true"
}