Skip to content

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.

GET
/v1/network-defence/sensors
curl --request GET \  --url https://api.xovris.ai/v1/network-defence/sensors \  --header 'Authorization: Bearer <token>'

A token that can read is enough.

Done.

Media typeapplication/json
object
items
required
Array<object>
object
sensor
required
string
engine
required
string
state
required
string
machine
required
One of:
object
name
required
string
deviceId
required
One of:
string
readAt
required
One of:
string
cpuPercent
required
One of:
number
memBytes
required
One of:
number
firstAt
required
One of:
string
lastAt
required
One of:
string
arrivedAt
required
One of:
string
everyS
required
One of:
number
pps
required
One of:
number
lossPct
required
One of:
number
worstLossPct
required
One of:
number
lastLossAt
required
One of:
string
restarts
required
number
restartedAt
required
One of:
string
lastAway
required
One of:
object
from
required
One of:
string
back
required
One of:
string
silent
required
number
missing
required
number
late
required
number
hosts
required
Array<object>
object
id
required
string
name
required
string
osVersion
required
One of:
string
seenAt
required
One of:
string
mayFix
required
boolean
mayListen
required
boolean
sensor
required
One of:
object
name
required
string
state
required
string
install
required
One of:
object
checkId
required
string
state
required
One of:
string
by
required
string
requestedAt
required
One of:
string
finishedAt
required
One of:
string
tookS
required
One of:
number
outcome
required
One of:
string
passed
required
boolean
detail
required
One of:
string
version
required
One of:
string
iface
required
One of:
string
proof
required
One of:
object
checkId
required
string
state
required
One of:
string
askedAt
required
One of:
string
at
required
One of:
string
stages
required
Array<object>
object
stage
required
string
ok
required
One of:
boolean
failed
required
One of:
string
detail
required
One of:
string
otherMachines
required
Array<object>
object
os
required
string
n
required
number

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.

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.