Upload Firmware File

POST

/api/firmware/{firmware_id}/upload

curl --request POST \
  --url 'https://example.com/api/firmware/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/upload?organization_id=2489E9AD-2EE2-8E00-8EC9-32D5F69181C0' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form file=@file

Upload an OTA-Pulse artifact (.otapulse file) for firmware deployment.

Only pre-built OTA-Pulse artifacts are accepted. To create one from a raw firmware image, use the otapulse-artifact CLI locally:

otapulse-artifact write rootfs-image \
    -t radxa-cm5-io \
    -n release-v1.0.0 \
    -f firmware.ext4 \
    -o firmware-v1.0.0.otapulse

Expects a multipart/form-data body with a single field named “file” (the same API contract as before amendment A8 — the console and test harness need no change).

Guardrails (TODO-052/S56 design 3A — see app.services.upload_guardrails): max upload size (413), free-disk-space floor (507), a GLOBAL concurrent upload cap (503, amendment A1), per-org storage quota (402), and a per-firmware upload lock (409) preventing two concurrent uploads from racing on one row — ALL of them run and, on refusal, respond BEFORE the body is streamed (amendment A8: this route no longer uses UploadFile = File(...), which would have made FastAPI itself buffer the entire body before this function even started — see app.services.streaming_multipart’s module docstring).

Authorizations

• HTTPBearer

Parameters

Path Parameters

firmware_id

required

Firmware Id

string format: uuid

Query Parameters

organization_id

required

Organization Id

string format: uuid

Request Body^required

Media type multipart/form-data

Body

object

file

required

File

string format: binary

Responses

200

Successful Response

Media type application/json

FirmwareResponse

Firmware response

object

checksum

required

Any of:

string

string

null

null

checksum_type

required

Checksum Type

string

created_at

required

Created At

string format: date-time

description

Any of:

string

string

null

null

download_count

required

Download Count

integer

failure_count

required

Failure Count

integer

file_path

Any of:

string

string

null

null

file_size

required

Any of:

integer

integer

null

null

hardware_versions

required

Hardware Versions

Array<string>

id

required

Id

string format: uuid

install_count

required

Install Count

integer

is_mandatory

required

Is Mandatory

boolean

is_mender_artifact

Is OTA artifact (deprecated)

Deprecated alias for is_ota_artifact. Use is_ota_artifact.

boolean

is_ota_artifact

Is Ota Artifact

boolean

min_version

required

Any of:

string

string

null

null

name

Any of:

string

string

<= 255 characters

null

null

organization_id

required

Organization Id

string format: uuid

release_notes

Any of:

string

string

null

null

released_at

required

Any of:

string

string format: date-time

null

null

rollout_percentage

required

Rollout Percentage

number

signature_status

Any of:

string

string

null

null

status

required

FirmwareStatus

Firmware status

string

Allowed values: draft testing released deprecated

version

required

Version

string

<= 100 characters

version_code

required

Any of:

integer

integer

null

null

Example

{
  "is_mender_artifact": false,
  "is_ota_artifact": false,
  "status": "draft"
}

422

Validation Error

Media type application/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

ctx

Context

object

input

Input

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Example ^generated

{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}