v1/firmware

Use the v1/firmware API to list, search, and download Digi device firmware and modem firmware.

You can also use the v1/firmware API to create, list, update or remove custom firmware. This can be useful in products where Digi does not provide firmware or if you want to provide your own firmware and use it the same way as other Digi firmware, even in Automations or Configurations.

Some notes about these APIs:

• Some of these APIs are available to an un-authenticated caller, other APIs require authentication or have features which require authentication. For example, setting the include_non_production parameter to true, requires that you have the permission to view non-production firmware, so an authenticated call is required.
• These APIs are also available using the firmware.devicecloud.com hostname. It is recommended you use the firmware.devicecloud.com hostname to access these APIS. Using this hostname will isolate you from future changes in firmware hosting infrastructure.
• The APIs for fetching firmware often redirect to another location. You should follow the redirect to get the firmware image.
• The APIs for listing firmware often return a secure, signed and expiring link. You can safely share this link to download the firmware image, but the link will usually expire in 24 hours.

URI

https://<hostname>/ws/v1/firmware

Formats

Payloads

The inventory_with_list API accepts a payload to filter the returned list. Specify one or more vendor IDs and device types to filter the list. The payload is a JSON array of objects with the following fields:

[{
    "vendor_id": "FE00000A",
    "device_type": "Digi EX15"
},
{
  "vendor_id": "FE00000A",
  "device_type": "Digi TX64"
}]

Path Parameters

These parameters are required in the URL path of some API calls.

Parameters