For the complete documentation index, see llms.txt. This page is also available as Markdown.

Uploads

Firmware file upload endpoints

Upload firmware

post

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.

Authorizations
AuthorizationstringRequired

OAuth2 Bearer token obtained from authentication endpoint

Body
upfilestring · binaryRequired

The firmware file to upload

typestring · enumRequired

Upload file type. Must be FIRMWARE. Required — without it the server rejects firmware file extensions and does not return the firmware metadata.

Example: FIRMWAREPossible values:
Responses
200

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

application/json

Response returned by POST /api/upload when uploading a firmware file (type=FIRMWARE). Feed path into pathToFirmware and firmwareInfo into firmwareInfo of the create shipment request.

pathstringOptional

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

Example: /static/fw_abc123def456.bin
post/api/upload

Last updated

Was this helpful?