NOnotefile
project

GET /v1/projects/{projectOrProductUID}/firmware

Changed on

Get Available Firmware Information

Request

  • Base URL
    https://api.notefile.net
  • URL
    https://api.notefile.net/v1/projects/{projectOrProductUID}/firmware
  • Auth
    HTTP bearer

Path parameters

projectOrProductUIDstring required

Query parameters

productstring
firmwareTypestring
versionstring
targetstring
filenamestring
md5string
unpublishedboolean
sortBy'created' | 'name' | 'version' | 'length'

Field to sort by

sortOrder'asc' | 'desc'

Sort order (asc for ascending, desc for descending)

Response

Success

builtstring

The date the firmware was built.

createdstring

The date the firmware was created.

descriptionstring

A description of the firmware.

filenamestring

The name of the firmware file.

infoobject

User-defined metadata

md5string

The MD5 hash of the firmware file.

notesstring

User-defined notes

organizationstring

The organization that owns the firmware.

productstring

The product that the firmware is for.

publishedboolean

True if the firmware is published.

tagsstring

A list of tags associated with the firmware.

targetstring

The target device for the firmware.

typestring

The type of firmware.

versionstring

The version of the firmware.

Changes

  • 1887e880199aRevision changes
    • breaking

      the response's body type changed from no type to object for status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 31a8d1f882c6Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status