Skip to content

Read a device

What you can call today

Every example here runs against api.xovris.ai with a key from your account’s settings. GET /v1/health and GET /v1/public/status answer without one.

GET
/v1/devices/{id}
curl --request GET \  --url https://api.xovris.ai/v1/devices/example \  --header 'Authorization: Bearer <token>'

A token that can read is enough.

id
required
string

Done.

Media typeapplication/json
object
device
required
object
id
required
string
name
required
string
kind
required
string
os
required
string
osVersion
required
One of:
string
arch
required
One of:
string
hostname
required
One of:
string
agentVersion
required
One of:
string
enrolledAt
required
string
lastSeenAt
required
One of:
string
state
required
string
healthEveryMinutes
required
One of:
number
healthDailyAt
required
One of:
string
ownership
required
One of:
string
cadence
required
object
everyMinutes
required
number
dailyAt
required
One of:
string
from
required
string
consent
required
One of:
object
id
required
string
scopes
required
Array<string>
Allowed values: health.read fix.apply network.diagnose logs.read lan.diagnose router.configure things.attached mcp.local net.reach
allowed
required
Array<string>
grantedBy
required
string
grantedAt
required
string
canAsk
required
Array<object>
object
kind
required
string
scope
required
string
Allowed values: health.read fix.apply network.diagnose logs.read lan.diagnose router.configure things.attached mcp.local net.reach
words
required
string
allowed
required
boolean
health
required
One of:
object
reportId
required
string
takenAt
required
string
findings
required
unmeasured
required
snapshot
required
network
required
One of:
object
reportId
required
string
takenAt
required
string
verdict
required
devicesAgree
required
providerCase
required
providerStatus
required
measurements
required
networkDevices
required
One of:
object
reportId
required
string
takenAt
required
string
diagnoses
required
containers
required
One of:
object
reportId
required
string
takenAt
required
string
engine
required
One of:
string
items
required
unmeasured
required
processes
required
One of:
object
reportId
required
string
takenAt
required
string
items
required
unmeasured
required
software
required
One of:
object
reportId
required
string
takenAt
required
string
packages
required
number
updates
required
number
loaded
required
One of:
number
running
required
Array<object>
object
name
required
string
version
required
string
ecosystem
required
string
available
required
One of:
string
fixes
required
Array<object>
object
reportId
required
string
takenAt
required
string
fix
required
finding
required
words
required
before
required
after
required
passed
required
rolledBack
required
outcome
required
detail
required
changed
required
moved
required
kept
required
unread
required
undo
required
One of:
object
state
required
string
Allowed values: ready
checkId
required
null
at
required
null
detail
required
null
guides
required
Array
checks
required
Array<object>
object
id
required
string
kind
required
string
words
required
string
state
required
string
reason
required
One of:
string
requestedBy
required
string
queuedAt
required
string
finishedAt
required
One of:
string
summary
required
reportId
required
error
required
One of:
string
activity
required
Array<object>
object
at
required
string
kind
required
string
line
required
string
actor
required
string
checkId
required
One of:
string

Example

{  "device": {    "id": "string",    "name": "string",    "kind": "string",    "os": "string",    "osVersion": "string",    "arch": "string",    "hostname": "string",    "agentVersion": "string",    "enrolledAt": "string",    "lastSeenAt": "string",    "state": "string",    "healthEveryMinutes": 1,    "healthDailyAt": "string",    "ownership": "string"  },  "cadence": {    "everyMinutes": 1,    "dailyAt": "string",    "from": "string"  },  "consent": {    "id": "string",    "scopes": [      "health.read"    ],    "allowed": [      "string"    ],    "grantedBy": "string",    "grantedAt": "string"  },  "canAsk": [    {      "kind": "string",      "scope": "health.read",      "words": "string",      "allowed": true    }  ],  "health": {    "reportId": "string",    "takenAt": "string",    "findings": null,    "unmeasured": null,    "snapshot": null  },  "network": {    "reportId": "string",    "takenAt": "string",    "verdict": null,    "devicesAgree": null,    "providerCase": null,    "providerStatus": null,    "measurements": null  },  "networkDevices": {    "reportId": "string",    "takenAt": "string",    "diagnoses": null  },  "containers": {    "reportId": "string",    "takenAt": "string",    "engine": "string",    "items": null,    "unmeasured": null  },  "processes": {    "reportId": "string",    "takenAt": "string",    "items": null,    "unmeasured": null  },  "software": {    "reportId": "string",    "takenAt": "string",    "packages": 1,    "updates": 1,    "loaded": 1,    "running": [      {        "name": "string",        "version": "string",        "ecosystem": "string",        "available": "string"      }    ]  },  "fixes": [    {      "reportId": "string",      "takenAt": "string",      "fix": null,      "finding": null,      "words": null,      "before": null,      "after": null,      "passed": null,      "rolledBack": null,      "outcome": null,      "detail": null,      "changed": null,      "moved": null,      "kept": null,      "unread": null,      "undo": {        "state": "ready",        "checkId": null,        "at": null,        "detail": null      }    }  ],  "guides": [    null  ],  "checks": [    {      "id": "string",      "kind": "string",      "words": "string",      "state": "string",      "reason": "string",      "requestedBy": "string",      "queuedAt": "string",      "finishedAt": "string",      "summary": null,      "reportId": null,      "error": "string"    }  ],  "activity": [    {      "at": "string",      "kind": "string",      "line": "string",      "actor": "string",      "checkId": "string"    }  ]}

Not signed in: the token is missing, expired or revoked. The answer says how to get a new one.

Media typeapplication/json
object
error
required
object
code
required

A stable code a program can branch on.

string
message
required

What happened, in plain words.

string
nextStep
required

What to do next.

string
decisionId

The recorded authorisation decision, when a role refused it.

string

Example generated

{  "error": {    "code": "example",    "message": "example",    "nextStep": "example",    "decisionId": "example"  }}

Signed in, but this token or role may not do this. The answer names the permission it needs.

Media typeapplication/json
object
error
required
object
code
required

A stable code a program can branch on.

string
message
required

What happened, in plain words.

string
nextStep
required

What to do next.

string
decisionId

The recorded authorisation decision, when a role refused it.

string

Example generated

{  "error": {    "code": "example",    "message": "example",    "nextStep": "example",    "decisionId": "example"  }}

Nothing with that id here, or it belongs to another workspace. Nothing was changed.

Media typeapplication/json
object
error
required
object
code
required

A stable code a program can branch on.

string
message
required

What happened, in plain words.

string
nextStep
required

What to do next.

string
decisionId

The recorded authorisation decision, when a role refused it.

string

Example generated

{  "error": {    "code": "example",    "message": "example",    "nextStep": "example",    "decisionId": "example"  }}

Any other refusal or failure. The answer says what happened and what to do next.

Media typeapplication/json
object
error
required
object
code
required

A stable code a program can branch on.

string
message
required

What happened, in plain words.

string
nextStep
required

What to do next.

string
decisionId

The recorded authorisation decision, when a role refused it.

string

Example generated

{  "error": {    "code": "example",    "message": "example",    "nextStep": "example",    "decisionId": "example"  }}

Ask Xovris

Open the full page

Your data is never used to train our AI. How your data is kept

A problem is called fixed only once it works again. How each fix is checked

XOVRIS LTD, registered in England and Wales, company number 17499910. Registered office: 66 Paul Street, London EC2A 4NA.