Skip to content
OTA-Pulse Docs

List Deployments

GET
/api/firmware/{firmware_id}/deployments

List deployments for a firmware version

Authorizations

Parameters

Path Parameters

firmware_id
required
string format: uuid

Query Parameters

organization_id
required
string format: uuid
status
Any of:

Deployment status for individual devices

string
Allowed values: pending downloading downloaded installing installed failed rolled_back

Responses

200

Successful Response

Array<object>

Firmware deployment status

object
completed_at
required
Any of:
string format: date-time
created_at
required
string format: date-time
device
Any of:

Short device info for deployment response

object
device_id
required
string
firmware_version
Any of:
string
id
required
string format: uuid
name
required
string
status
required
string
device_id
required
string format: uuid
error_message
required
Any of:
string
firmware_id
required
string format: uuid
from_version
required
Any of:
string
id
required
string format: uuid
progress
required
number
retry_count
required
integer
started_at
required
Any of:
string format: date-time
status
required

Deployment status for individual devices

string
Allowed values: pending downloading downloaded installing installed failed rolled_back
to_version
required
string

422

Validation Error

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