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.
const url = 'https://api.xovris.ai/v1/network/map';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/map \ --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
object
object
object
object
object
object
object
object
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.
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.