Skip to content

See how your network is wired: every device read on it and the links between them, with their speed and traffic

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

A token that can read is enough.

Done.

Media typeapplication/json
One of:
object
coverage
required
object
items
required
Array<object>
object
node
required
string
name
required
string
kind
required
string
Allowed values: server phone router other computer firewall switch access_point printer nas camera internet
address
required
One of:
string
state
required
string
Allowed values: missing stale observed enforceable protected
unrecorded
required
boolean
isNew
required
One of:
boolean
newWhy
required
One of:
string
offNetwork
required
boolean
awayAt
required
One of:
string
unplaced
required
boolean
accounts
required
Array<string>
services
required
Array<string>
dependsOn
required
Array<string>
lastSeen
required
One of:
string
why
required
string
next
required
One of:
string
segments
required
Array<object>
object
prefix
required
string
source
required
string
Allowed values: record met
state
required
string
Allowed values: missing read observed
assets
required
number
readers
required
Array<string>
why
required
string
next
required
One of:
string
counts
required
object
missing
required
number
stale
required
number
observed
required
number
enforceable
required
number
protected
required
number
unrecorded
required
number
unplaced
required
number
offNetwork
required
number
new
required
number
accounts
required
number
services
required
number
segmentsRead
required
number
segments
required
number
newSince
required
One of:
string
complete
required
boolean
why
required
string
nodes
required
Array<object>
object
id
required
string
name
required
string
kind
required
string
Allowed values: server phone router other computer firewall switch access_point printer nas camera internet
maker
required
One of:
string
model
required
One of:
string
address
required
One of:
string
deviceId
required
One of:
string
readBy
required
One of:
string
readAt
required
One of:
string
ports
required
object
total
required
number
up
required
number
portList
required
Array<object>
object
name
required
string
speedMbps
required
One of:
number
oper
required
string
Allowed values: up down unknown
inBps
required
One of:
number
outBps
required
One of:
number
use
required
One of:
number
errorsPerMin
required
One of:
number
flaps24h
required
One of:
number
lastChange
required
One of:
string
doors
required
Array<object>
object
kind
required
string
port
required
number
path
required
One of:
string
config
required
boolean
configures
required
Array<string>
configVia
required
One of:
object
kind
required
string
port
required
number
path
required
One of:
string
config
required
boolean
location
required
One of:
string
contact
required
One of:
string
heard
Array<object>
object
at
required
string
kind
required
string
Allowed values: link_down log link_up trap
port
required
One of:
string
ifIndex
One of:
number
line
required
string
severity
required
number
by
required
string
talkers
Array<object>
object
src
required
string
dst
required
string
bytes
required
number
packets
required
number
recorded
One of:
object
in
required
string
Allowed values: netbox
id
required
One of:
number
site
required
One of:
string
role
required
One of:
string
status
required
One of:
string
serial
required
One of:
string
rack
required
One of:
string
tenant
required
One of:
string
platform
required
One of:
string
seen
boolean
networks
Array<string>
app
One of:
object
lastSeenAt
required
One of:
string
fix
required
boolean
addresses
Array<string>
user
One of:
string
services
Array<string>
enrolledAt
One of:
string
links
required
Array<object>
object
id
required
string
a
required
object
node
required
string
port
required
One of:
string
b
required
object
node
required
string
port
required
One of:
string
via
required
string
speedMbps
required
One of:
number
inBps
required
One of:
number
outBps
required
One of:
number
use
required
One of:
number
oper
required
string
Allowed values: up down unknown
flaps24h
required
One of:
number
last
required
One of:
object
at
required
string
line
required
string
readAt
required
One of:
string
readBy
required
Array<string>
empty
required
One of:
string
record
One of:
object
in
required
string
Allowed values: netbox
url
required
One of:
string
version
required
One of:
string
readAt
required
string
by
required
string
recorded
required
number
matched
required
number
recordedOnly
required
number
unrecorded
required
number
counted
required
object
key
additional properties
number
truncated
required
Array<string>
prefixes
required
Array<object>
object
prefix
required
string
scope
required
One of:
string
vlan
required
One of:
string
description
required
One of:
string
untrusted
required
One of:
string
networks
Array<object>
object
id
required
string
name
required
string
source
required
string
Allowed values: record reading
nodes
required
number

Example

{  "coverage": {    "items": [      {        "node": "string",        "name": "string",        "kind": "server",        "address": "string",        "state": "missing",        "unrecorded": true,        "isNew": true,        "newWhy": "string",        "offNetwork": true,        "awayAt": "string",        "unplaced": true,        "accounts": [          "string"        ],        "services": [          "string"        ],        "dependsOn": [          "string"        ],        "lastSeen": "string",        "why": "string",        "next": "string"      }    ],    "segments": [      {        "prefix": "string",        "source": "record",        "state": "missing",        "assets": 1,        "readers": [          "string"        ],        "why": "string",        "next": "string"      }    ],    "counts": {      "missing": 1,      "stale": 1,      "observed": 1,      "enforceable": 1,      "protected": 1,      "unrecorded": 1,      "unplaced": 1,      "offNetwork": 1,      "new": 1,      "accounts": 1,      "services": 1,      "segmentsRead": 1,      "segments": 1    },    "newSince": "string",    "complete": true,    "why": "string"  },  "nodes": [    {      "id": "string",      "name": "string",      "kind": "server",      "maker": "string",      "model": "string",      "address": "string",      "deviceId": "string",      "readBy": "string",      "readAt": "string",      "ports": {        "total": 1,        "up": 1      },      "portList": [        {          "name": "string",          "speedMbps": 1,          "oper": "up",          "inBps": 1,          "outBps": 1,          "use": 1,          "errorsPerMin": 1,          "flaps24h": 1,          "lastChange": "string"        }      ],      "doors": [        {          "kind": "string",          "port": 1,          "path": "string",          "config": true        }      ],      "configures": [        "string"      ],      "configVia": {        "kind": "string",        "port": 1,        "path": "string",        "config": true      },      "location": "string",      "contact": "string",      "heard": [        {          "at": "string",          "kind": "link_down",          "port": "string",          "ifIndex": 1,          "line": "string",          "severity": 1,          "by": "string"        }      ],      "talkers": [        {          "src": "string",          "dst": "string",          "bytes": 1,          "packets": 1        }      ],      "recorded": {        "in": "netbox",        "id": 1,        "site": "string",        "role": "string",        "status": "string",        "serial": "string",        "rack": "string",        "tenant": "string",        "platform": "string"      },      "seen": true,      "networks": [        "string"      ],      "app": {        "lastSeenAt": "string",        "fix": true,        "addresses": [          "string"        ],        "user": "string",        "services": [          "string"        ],        "enrolledAt": "string"      }    }  ],  "links": [    {      "id": "string",      "a": {        "node": "string",        "port": "string"      },      "b": {        "node": "string",        "port": "string"      },      "via": "string",      "speedMbps": 1,      "inBps": 1,      "outBps": 1,      "use": 1,      "oper": "up",      "flaps24h": 1,      "last": {        "at": "string",        "line": "string"      }    }  ],  "readAt": "string",  "readBy": [    "string"  ],  "empty": "string",  "record": {    "in": "netbox",    "url": "string",    "version": "string",    "readAt": "string",    "by": "string",    "recorded": 1,    "matched": 1,    "recordedOnly": 1,    "unrecorded": 1,    "counted": {},    "truncated": [      "string"    ],    "prefixes": [      {        "prefix": "string",        "scope": "string",        "vlan": "string",        "description": "string"      }    ],    "untrusted": "string"  },  "networks": [    {      "id": "string",      "name": "string",      "source": "record",      "nodes": 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.