curl --request POST \
--url https://www.closient.com/products/api/v1/firmware \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"gtins": [
"00850012345671"
],
"url": "https://downloads.example.com/kettle/2.4.1.bin",
"version": "2.4.1"
}
'import requests
url = "https://www.closient.com/products/api/v1/firmware"
payload = {
"gtins": ["00850012345671"],
"url": "https://downloads.example.com/kettle/2.4.1.bin",
"version": "2.4.1"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
gtins: ['00850012345671'],
url: 'https://downloads.example.com/kettle/2.4.1.bin',
version: '2.4.1'
})
};
fetch('https://www.closient.com/products/api/v1/firmware', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://www.closient.com/products/api/v1/firmware",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'gtins' => [
'00850012345671'
],
'url' => 'https://downloads.example.com/kettle/2.4.1.bin',
'version' => '2.4.1'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://www.closient.com/products/api/v1/firmware"
payload := strings.NewReader("{\n \"gtins\": [\n \"00850012345671\"\n ],\n \"url\": \"https://downloads.example.com/kettle/2.4.1.bin\",\n \"version\": \"2.4.1\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://www.closient.com/products/api/v1/firmware")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"gtins\": [\n \"00850012345671\"\n ],\n \"url\": \"https://downloads.example.com/kettle/2.4.1.bin\",\n \"version\": \"2.4.1\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.closient.com/products/api/v1/firmware")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"gtins\": [\n \"00850012345671\"\n ],\n \"url\": \"https://downloads.example.com/kettle/2.4.1.bin\",\n \"version\": \"2.4.1\"\n}"
response = http.request(request)
puts response.read_body{
"checksum_sha256": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
"created": "2026-09-30T09:00:00Z",
"description": "Improves temperature stability.",
"file_url": "",
"id": "F5n5NdW6dTbvPYkgnLNjte",
"is_latest": true,
"is_stable": true,
"maximum_hardware_version": "3.x",
"minimum_hardware_version": "1.0",
"modified": "2026-09-30T09:00:00Z",
"products": [
{
"gtin": "00850012345671",
"id": "SBjSX6xUJPPHQKUXBpYX2C",
"product_name": "Acme Smart Kettle"
}
],
"release_date": "2026-09-01",
"release_notes": "Fixes a boil-over bug.",
"size_kb": 512,
"title": "Acme Kettle firmware 2.4.1",
"url": "https://downloads.example.com/kettle/2.4.1.bin",
"version": "2.4.1"
}{
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"status": 404,
"timestamp": "2026-03-31T12:00:00+00:00",
"title": "Not Found",
"type": "https://closient.com/docs/errors/not_found"
}{
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"status": 404,
"timestamp": "2026-03-31T12:00:00+00:00",
"title": "Not Found",
"type": "https://closient.com/docs/errors/not_found"
}{
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"status": 404,
"timestamp": "2026-03-31T12:00:00+00:00",
"title": "Not Found",
"type": "https://closient.com/docs/errors/not_found"
}{
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"status": 404,
"timestamp": "2026-03-31T12:00:00+00:00",
"title": "Not Found",
"type": "https://closient.com/docs/errors/not_found"
}{
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"status": 404,
"timestamp": "2026-03-31T12:00:00+00:00",
"title": "Not Found",
"type": "https://closient.com/docs/errors/not_found"
}{
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"status": 404,
"timestamp": "2026-03-31T12:00:00+00:00",
"title": "Not Found",
"type": "https://closient.com/docs/errors/not_found"
}{
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"status": 404,
"timestamp": "2026-03-31T12:00:00+00:00",
"title": "Not Found",
"type": "https://closient.com/docs/errors/not_found"
}Create firmware
Create a firmware release and show it on the listed products. Requires CONTRIBUTE on the organization that owns them; 404 if any GTIN isn’t one of its products, and nothing is created.
curl --request POST \
--url https://www.closient.com/products/api/v1/firmware \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"gtins": [
"00850012345671"
],
"url": "https://downloads.example.com/kettle/2.4.1.bin",
"version": "2.4.1"
}
'import requests
url = "https://www.closient.com/products/api/v1/firmware"
payload = {
"gtins": ["00850012345671"],
"url": "https://downloads.example.com/kettle/2.4.1.bin",
"version": "2.4.1"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
gtins: ['00850012345671'],
url: 'https://downloads.example.com/kettle/2.4.1.bin',
version: '2.4.1'
})
};
fetch('https://www.closient.com/products/api/v1/firmware', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://www.closient.com/products/api/v1/firmware",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'gtins' => [
'00850012345671'
],
'url' => 'https://downloads.example.com/kettle/2.4.1.bin',
'version' => '2.4.1'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://www.closient.com/products/api/v1/firmware"
payload := strings.NewReader("{\n \"gtins\": [\n \"00850012345671\"\n ],\n \"url\": \"https://downloads.example.com/kettle/2.4.1.bin\",\n \"version\": \"2.4.1\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://www.closient.com/products/api/v1/firmware")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"gtins\": [\n \"00850012345671\"\n ],\n \"url\": \"https://downloads.example.com/kettle/2.4.1.bin\",\n \"version\": \"2.4.1\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.closient.com/products/api/v1/firmware")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"gtins\": [\n \"00850012345671\"\n ],\n \"url\": \"https://downloads.example.com/kettle/2.4.1.bin\",\n \"version\": \"2.4.1\"\n}"
response = http.request(request)
puts response.read_body{
"checksum_sha256": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
"created": "2026-09-30T09:00:00Z",
"description": "Improves temperature stability.",
"file_url": "",
"id": "F5n5NdW6dTbvPYkgnLNjte",
"is_latest": true,
"is_stable": true,
"maximum_hardware_version": "3.x",
"minimum_hardware_version": "1.0",
"modified": "2026-09-30T09:00:00Z",
"products": [
{
"gtin": "00850012345671",
"id": "SBjSX6xUJPPHQKUXBpYX2C",
"product_name": "Acme Smart Kettle"
}
],
"release_date": "2026-09-01",
"release_notes": "Fixes a boil-over bug.",
"size_kb": 512,
"title": "Acme Kettle firmware 2.4.1",
"url": "https://downloads.example.com/kettle/2.4.1.bin",
"version": "2.4.1"
}{
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"status": 404,
"timestamp": "2026-03-31T12:00:00+00:00",
"title": "Not Found",
"type": "https://closient.com/docs/errors/not_found"
}{
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"status": 404,
"timestamp": "2026-03-31T12:00:00+00:00",
"title": "Not Found",
"type": "https://closient.com/docs/errors/not_found"
}{
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"status": 404,
"timestamp": "2026-03-31T12:00:00+00:00",
"title": "Not Found",
"type": "https://closient.com/docs/errors/not_found"
}{
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"status": 404,
"timestamp": "2026-03-31T12:00:00+00:00",
"title": "Not Found",
"type": "https://closient.com/docs/errors/not_found"
}{
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"status": 404,
"timestamp": "2026-03-31T12:00:00+00:00",
"title": "Not Found",
"type": "https://closient.com/docs/errors/not_found"
}{
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"status": 404,
"timestamp": "2026-03-31T12:00:00+00:00",
"title": "Not Found",
"type": "https://closient.com/docs/errors/not_found"
}{
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"status": 404,
"timestamp": "2026-03-31T12:00:00+00:00",
"title": "Not Found",
"type": "https://closient.com/docs/errors/not_found"
}Authorizations
Body
Payload for POST /firmware.
Firmware version label.
1 - 50^[^\x00]{1,50}$Download URL. Must start with https://.
9 - 200^[Hh][Tt][Tt][Pp][Ss]://[^\x00-\x20\x7f/?#][^\x00-\x20\x7f]{0,191}$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.
1 - 200 elements8 - 14Display title.
255^[^\x00]{0,255}$Release date (YYYY-MM-DD).
Short description.
^[^\x00]{0,}$Download size in kilobytes.
0 <= x <= 2147483647Oldest hardware revision this runs on.
50^[^\x00]{0,50}$Newest hardware revision this runs on.
50^[^\x00]{0,50}$Lowercase hex SHA-256 of the download (64 characters).
64^([0-9a-f]{64})?$Release notes.
^[^\x00]{0,}$Whether this is the current release.
Whether this is a stable release rather than a beta.
Response
Created
A firmware release with the products it is shown on.
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).
22^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$Firmware version label.
Display title. Empty string when unset.
Download URL (https). Empty string when only an uploaded file exists.
URL of a file uploaded by staff through the admin. Empty string when there is none.
Release date, or null when unknown.
Short description. Empty string when unset.
Download size in kilobytes. 0 when unknown.
Oldest hardware revision this runs on. Empty when unset.
Newest hardware revision this runs on. Empty when unset.
Lowercase hex SHA-256 of the download. Empty when unset.
Release notes. Empty string when unset.
Whether this is the current release.
Whether this is a stable release rather than a beta.
The products this firmware is shown on, by GTIN.
Show child attributes
Show child attributes
Server-side ISO 8601 timestamp of creation (UTC).
Server-side ISO 8601 timestamp of last modification (UTC).