Skip to content

Get Device Summary

GET
/api/devices/summary
curl --request GET \
--url 'https://example.com/api/devices/summary?organization_id=2489E9AD-2EE2-8E00-8EC9-32D5F69181C0' \
--header 'Authorization: Bearer <token>'

Get device fleet summary for organization

organization_id
required
Organization Id
string format: uuid

Successful Response

Media type application/json
DeviceSummary

Device fleet summary

object
degraded
required
Degraded
integer
error
required
Error
integer
offline
required
Offline
integer
online
required
Online
integer
total
required
Total
integer
updating
required
Updating
integer
Example generated
{
"degraded": 1,
"error": 1,
"offline": 1,
"online": 1,
"total": 1,
"updating": 1
}

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"
}
]
}