See every network sensor's own health: reporting or stopped, the traffic it handles and the share it misses
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/network-defence/sensors';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/network-defence/sensors \ --header 'Authorization: Bearer <token>'A token that can read is enough.
Authorizations
Section titled “Authorizations”Responses
Section titled “Responses”Done.
object
object
object
object
object
object
Example
{ "items": [ { "sensor": "string", "engine": "string", "state": "string", "machine": { "name": "string", "deviceId": "string", "readAt": "string", "cpuPercent": 1, "memBytes": 1 }, "firstAt": "string", "lastAt": "string", "arrivedAt": "string", "everyS": 1, "pps": 1, "lossPct": 1, "worstLossPct": 1, "lastLossAt": "string", "restarts": 1, "restartedAt": "string", "lastAway": { "from": "string", "back": "string" } } ], "silent": 1, "missing": 1, "late": 1, "hosts": [ { "id": "string", "name": "string", "osVersion": "string", "seenAt": "string", "mayFix": true, "mayListen": true, "sensor": { "name": "string", "state": "string" }, "install": { "checkId": "string", "state": "string", "by": "string", "requestedAt": "string", "finishedAt": "string", "tookS": 1, "outcome": "string", "passed": true, "detail": "string", "version": "string", "iface": "string" }, "proof": { "checkId": "string", "state": "string", "askedAt": "string", "at": "string", "stages": [ { "stage": "string", "ok": true } ], "failed": "string", "detail": "string" } } ], "otherMachines": [ { "os": "string", "n": 1 } ]}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.