List custom firmware

The following sample request lists all firmware for the provided vendor ID and device type. Note that this request includes both Digi device firmware and custom device firmware. Custom firmware includes the customer_id parameter in the response, while Digi firmware does not.

Request

GET /ws/v1/firmware/inventory/{vendor_id}/{device_type}

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 No 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.
get_all_artifacts boolean No true to get all artifacts for each firmware version, false to only get the main image. It defaults to false.
include_non_production boolean No true to include non-production firmware in the list, false to only get production firmware. It defaults to false.
include_deprecated boolean No true to include deprecated firmware in the list, false to only get non-deprecated firmware. It defaults to false.

Response

{
    "count": 2,
    "size": 2,
    "list": [
        {
            "location": "https://com-digi-drm-filedata-prod.s3.amazonaws.com/Forever/prdMy/2/firmware/fe080003-DEY.device-1.0.0.1.3c0eed65-02d8-4096-891f-29cbec8c42e1?response-content-disposition=attachment%3B%20filename%3D%221.0.0.1.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=d6973c3e58f51841a4039bb5bfb2d8e5a589cbcd4586c869a3e2ec0547232740",
            "vendor_id": 4261937155,
            "type": "DEY device",
            "firmware_version": "1.0.0.1",
            "file_size": 45456,
            "production": true,
            "deprecated": false,
            "filename": "1.0.0.1.swu",
            "information_link": "https://www.digi.com",
            "security_related": "none",
            "sha_512": "861844d6704e8573fec34d967e20bcfef3d424cf48be04e6dc08f2bd58c729743371015ead891cc3cf1c9d34b49264b510751b1ff9e537937bc46b5d6ff4ecc8",
            "sha3_512": "32400b5e89822de254e8d5d94252c52bdcb27a3562ca593e980364d9848b8041b98eabe16c1a6797484941d2376864a1b0e248b0f7af8b1555a778c336a5bf48",
            "firmware_status": "high",
            "customer_id": 2,
            "shared": "all"
        },
        {
            "location": "https://com-digi-drm-filedata-prod.s3.amazonaws.com/Forever/prdMy/2/firmware/fe080003-DEY.device-1.0.0.0.b1508b02-5158-459b-a4e8-cd9502fd062d?response-content-disposition=attachment%3B%20filename%3D%221.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": "1.0.0.0",
            "file_size": 407887,
            "production": true,
            "deprecated": false,
            "filename": "1.0.0.0.swu",
            "information_link": "https://www.digi.com",
            "security_related": "none",
            "sha_512": "861844d6704e8573fec34d967e20bcfef3d424cf48be04e6dc08f2bd58c729743371015ead891cc3cf1c9d34b49264b510751b1ff9e537937bc46b5d6ff4ecc8",
            "sha3_512": "32400b5e89822de254e8d5d94252c52bdcb27a3562ca593e980364d9848b8041b98eabe16c1a6797484941d2376864a1b0e248b0f7af8b1555a778c336a5bf48",
            "firmware_status": "none"
        }
    ]
}