Skip to content
OTA-Pulse Docs

List Devices

GET
/api/devices

List devices for organization

Authorizations

Parameters

Query Parameters

organization_id
required
string format: uuid
page
integer
default: 1 >= 1
per_page
integer
default: 20 >= 1 <= 100
status
Any of:

Device status

string
Allowed values: online offline degraded updating error unknown
search
Any of:
string
tag
Any of:
string

Responses

200

Successful Response

Paginated device list

object
items
required
Array<object>

Device response schema

object
attributes
Any of:
object
cpu_usage
required
Any of:
number
crash_count
required
integer
created_at
required
string format: date-time
description
Any of:
string
device_id
required
string
disk_usage
required
Any of:
number
firmware_version
required
Any of:
string
hardware_version
required
Any of:
string
id
required
string format: uuid
is_active
required
boolean
last_boot
required
Any of:
string format: date-time
last_ip
required
Any of:
string
last_seen
required
Any of:
string format: date-time
mac_address
required
Any of:
string
memory_usage
required
Any of:
number
name
Any of:
string
<= 255 characters
organization_id
required
string format: uuid
reboot_count
required
integer
registered_at
required
string format: date-time
serial_number
required
Any of:
string
status
required

Device status

string
Allowed values: online offline degraded updating error unknown
tags
Any of:
object
key
additional properties
string
temperature
required
Any of:
number
uptime_seconds
required
Any of:
number
page
required
integer
per_page
required
integer
total
required
integer

422

Validation Error

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