Skip to content

Deploy Firmware

POST
/api/firmware/{firmware_id}/deploy

Deploy firmware to devices.

When force=False (default) any device whose current firmware_version is below the firmware’s min_version is silently skipped.

When force=True those devices are included anyway (with a warning), but only an org owner (OWNER or ADMIN role) may set this flag.

Authorizations

Parameters

Path Parameters

firmware_id
required
string format: uuid

Query Parameters

organization_id
required
string format: uuid

Request Body required

Create deployment request

object
device_ids
required
Array<string>
force
boolean
rollout_percentage
Any of:
number
<= 100

Responses

200

Successful Response

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string