v1

latestOpenAPI 3.0.32026-07-23194968.1 KB
Uploads

Upload firmware

Upload a firmware binary file to the server. This is the first step when creating an OTA shipment: the response gives you the values required by POST /api/v1/organization/shipment/create.

The file type is determined by the type form field:

  • FIRMWARE — OTA firmware binary (.bin, .zip, .tar, .gz, .hs, .xz, .bz2, .tar.gz, .ota.bin.gz, .bin.gz, .bin.hs, .yml, .yaml)

The maximum file size is 10 MB.

On success the server stores the file and returns a JSON object with:

  • path — the server path to the stored firmware. Pass it as pathToFirmware when creating the shipment.
  • firmwareInfo — metadata parsed from the binary (version, board type, hashes, size, …). Pass it as firmwareInfo when creating the shipment. It may be null if the file could not be parsed.

Authentication: Use an OAuth2 Bearer token in the Authorization header.

post/api/upload

Response

File uploaded successfully. Returns the server path to the stored firmware and the parsed firmware metadata.

pathstring

Server path to the stored firmware file. Pass this value as pathToFirmware when creating a shipment.