Skip to content

List devices

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
curl --request GET \  --url https://api.xovris.ai/v1/devices \  --header 'Authorization: Bearer <token>'

A token that can read is enough.

Done.

Media typeapplication/json
object
empty
required
One of:
string
start
object
label
required
string
method
required
string
Allowed values: POST
path
required
string
Allowed values: /v1/devices/enrolment-codes
items
required
Array<object>
object
allowed
required
Array<string>
Allowed values: health.read fix.apply network.diagnose logs.read lan.diagnose router.configure things.attached mcp.local net.reach
health
required
One of:
object
takenAt
required
findings
required
worst
required
network
required
software
required
containers
required
serial
required
One of:
string
assetTag
required
One of:
string
user
required
One of:
string
model
required
One of:
string
manufacturer
required
One of:
string
ip
required
One of:
string
mac
required
One of:
string
batteryHealth
required
One of:
number
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

Example

{  "empty": "string",  "start": {    "label": "string",    "method": "POST",    "path": "/v1/devices/enrolment-codes"  },  "items": [    {      "allowed": [        "health.read"      ],      "health": {        "takenAt": null,        "findings": null,        "worst": null      },      "network": null,      "software": null,      "containers": null,      "serial": "string",      "assetTag": "string",      "user": "string",      "model": "string",      "manufacturer": "string",      "ip": "string",      "mac": "string",      "batteryHealth": 1,      "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"    }  ]}

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.