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.
const url = 'https://api.xovris.ai/v1/devices/example';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://api.xovris.ai/v1/devices/example \ --header 'Authorization: Bearer <token>'A token that can read is enough.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Responses
Section titled “Responses”Done.
object
object
object
object
object
object
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.
object
object
A stable code a program can branch on.
What happened, in plain words.
What to do next.
The recorded authorisation decision, when a role refused it.
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.
object
object
A stable code a program can branch on.
What happened, in plain words.
What to do next.
The recorded authorisation decision, when a role refused it.
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.
object
object
A stable code a program can branch on.
What happened, in plain words.
What to do next.
The recorded authorisation decision, when a role refused it.
Example generated
{ "error": { "code": "example", "message": "example", "nextStep": "example", "decisionId": "example" }}default
Section titled “default”Any other refusal or failure. The answer says what happened and what to do next.
object
object
A stable code a program can branch on.
What happened, in plain words.
What to do next.
The recorded authorisation decision, when a role refused it.
Example generated
{ "error": { "code": "example", "message": "example", "nextStep": "example", "decisionId": "example" }}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.