{
  "data": {
    "architecture": "arm",
    "author": "NervesHub",
    "platform": "rpi0",
    "product": "MyProduct",
    "tool": "fwup",
    "uuid": "d9f8c63a-1234-5678-abcd-ef0123456789",
    "version": "1.0.0"
  }
}

{
  "errors": {
    "detail": "Resource Not Found or Authorization Insufficient"
  }
}

{
  "errors": {
    "detail": "Resource Not Found or Authorization Insufficient"
  }
}

{
  "errors": {
    "detail": "This ESP-IDF image is not signed. Sign it with `espsecure.py sign_data --version 2` and register the matching public key against your organization, or allow unsigned images in this product's settings."
  }
}

Firmwares

Upload a Firmware for a Product

Accepts an fwup archive (.fw) or an ESP-IDF application image (.bin). The format is determined from the file itself, not its name or extension.

A product accepts only the formats listed in its allowed_update_tools, which is ["fwup"] by default. ESP-IDF additionally requires the platform to have ESP_IDF_FIRMWARE_ENABLED set.

Firmware must be signed against a key registered to the organization: an Ed25519 key for fwup and AtomVM, or an RSA-3072 Secure Boot v2 key for ESP-IDF.

Two per-product settings excuse a missing signature, and nothing else. allow_unsigned_esp_idf_firmware accepts an ESP-IDF image with no signature block, and allow_unsigned_atomvm_firmware accepts a packbeam with no signature entry. Firmware that does carry a signature is always verified, and fwup archives are always verified.

The firmware’s own metadata declares which product it belongs to, and that must match the product in the path.

POST

api

orgs

{org_name}

products

{product_name}

firmwares

{
  "data": {
    "architecture": "arm",
    "author": "NervesHub",
    "platform": "rpi0",
    "product": "MyProduct",
    "tool": "fwup",
    "uuid": "d9f8c63a-1234-5678-abcd-ef0123456789",
    "version": "1.0.0"
  }
}

{
  "errors": {
    "detail": "Resource Not Found or Authorization Insufficient"
  }
}

{
  "errors": {
    "detail": "Resource Not Found or Authorization Insufficient"
  }
}

{
  "errors": {
    "detail": "This ESP-IDF image is not signed. Sign it with `espsecure.py sign_data --version 2` and register the matching public key against your organization, or allow unsigned images in this product's settings."
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

org_name

string

required

Organization Name

product_name

string

required

Product Name

Response

Firmware response

Response schema for a single Firmware

data

Firmware · object

Show child attributes

Example:

{
  "architecture": "arm",
  "author": "NervesHub",
  "platform": "rpi0",
  "product": "MyProduct",
  "tool": "fwup",
  "uuid": "d9f8c63a-1234-5678-abcd-ef0123456789",
  "version": "1.0.0"
}

HTTP API

Endpoints

Device WebSocket

Upload a Firmware for a Product

Authorizations

Path Parameters

Response