Skip to main content
POST
Create firmware

Authorizations

X-API-Key
string
header
required

Body

application/json

Payload for POST /firmware.

version
string
required

Firmware version label.

Required string length: 1 - 50
Pattern: ^[^\x00]{1,50}$
url
string
required

Download URL. Must start with https://.

Required string length: 9 - 200
Pattern: ^[Hh][Tt][Tt][Pp][Ss]://[^\x00-\x20\x7f/?#][^\x00-\x20\x7f]{0,191}$
gtins
string<gtin>[]
required

GTINs of the products to show the firmware on (8, 12, 13 or 14 digits). Each must be a product the caller's organization owns, else 404 and nothing is created.

Required array length: 1 - 200 elements
Required string length: 8 - 14
title
string
default:""

Display title.

Maximum string length: 255
Pattern: ^[^\x00]{0,255}$
release_date
string<date> | null

Release date (YYYY-MM-DD).

description
string
default:""

Short description.

Pattern: ^[^\x00]{0,}$
size_kb
integer
default:0

Download size in kilobytes.

Required range: 0 <= x <= 2147483647
minimum_hardware_version
string
default:""

Oldest hardware revision this runs on.

Maximum string length: 50
Pattern: ^[^\x00]{0,50}$
maximum_hardware_version
string
default:""

Newest hardware revision this runs on.

Maximum string length: 50
Pattern: ^[^\x00]{0,50}$
checksum_sha256
string
default:""

Lowercase hex SHA-256 of the download (64 characters).

Maximum string length: 64
Pattern: ^([0-9a-f]{64})?$
release_notes
string
default:""

Release notes.

Pattern: ^[^\x00]{0,}$
is_latest
boolean
default:false

Whether this is the current release.

is_stable
boolean
default:true

Whether this is a stable release rather than a beta.

Response

Created

A firmware release with the products it is shown on.

id
string<shortuuid>
required

URL-safe 22-character shortuuid encoding of the row's UUID primary key. Stable across the row's lifetime; suitable for sharing in URLs, log lines, and external SDK clients. Accepted on input as either the shortuuid form or the canonical UUID form (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
version
string
required

Firmware version label.

title
string
required

Display title. Empty string when unset.

url
string
required

Download URL (https). Empty string when only an uploaded file exists.

file_url
string
required

URL of a file uploaded by staff through the admin. Empty string when there is none.

release_date
string<date> | null
required

Release date, or null when unknown.

description
string
required

Short description. Empty string when unset.

size_kb
integer
required

Download size in kilobytes. 0 when unknown.

minimum_hardware_version
string
required

Oldest hardware revision this runs on. Empty when unset.

maximum_hardware_version
string
required

Newest hardware revision this runs on. Empty when unset.

checksum_sha256
string
required

Lowercase hex SHA-256 of the download. Empty when unset.

release_notes
string
required

Release notes. Empty string when unset.

is_latest
boolean
required

Whether this is the current release.

is_stable
boolean
required

Whether this is a stable release rather than a beta.

products
FirmwareProductOut · object[]
required

The products this firmware is shown on, by GTIN.

created
string<date-time>
required

Server-side ISO 8601 timestamp of creation (UTC).

modified
string<date-time>
required

Server-side ISO 8601 timestamp of last modification (UTC).