Skip to content

See one network incident's whole record: its timeline, the devices it touched, every decision and action with its proof

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/incidents/{id}
curl --request GET \  --url https://api.xovris.ai/v1/network-defence/incidents/example \  --header 'Authorization: Bearer <token>'

A token that can read is enough.

id
required
string

Done.

Media typeapplication/json
object
id
required
string
name
required
string
level
required
string
risk
required
number
state
required
string
src
required
string
dest
required
string
mitre
required
Array<object>
object
tacticId
required
string
tactic
required
string
techniqueId
required
One of:
string
technique
required
One of:
string
inferred
required
boolean
cves
required
Array<string>
automatic
required
One of:
object
at
required
string
requested
required
number
walls
required
Array<string>
why
required
string
explanation
required
object
headline
required
string
whatHappened
required
string
whyItMatters
required
string
whatXovrisDoes
required
string
whatYouCanDo
required
Array<string>
reasons
required
Array<string>
assets
required
Array<object>
object
address
required
string
role
required
string
node
required
One of:
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
deviceId
required
One of:
string
timeline
required
Array<object>
object
at
required
string
kind
required
string
Allowed values: state decision action outcome observed
words
required
string
by
string
decisionId
One of:
string
proof
evidence
required
object
lines
required
number
first
required
One of:
string
last
required
One of:
string
blocked
required
number
sensors
required
Array<string>
engines
required
Array<string>
integrity
required
object
intact
required
boolean
chained
required
number
unchained
required
number
altered
required
number
missing
required
number
brokenLinks
required
number
latest
required
One of:
object
seq
required
number
head
required
string
digest
required
One of:
string
how
required
string
next
required
Array<string>

Example

{  "id": "string",  "name": "string",  "level": "string",  "risk": 1,  "state": "string",  "src": "string",  "dest": "string",  "mitre": [    {      "tacticId": "string",      "tactic": "string",      "techniqueId": "string",      "technique": "string",      "inferred": true    }  ],  "cves": [    "string"  ],  "automatic": {    "at": "string",    "requested": 1,    "walls": [      "string"    ],    "why": "string"  },  "explanation": {    "headline": "string",    "whatHappened": "string",    "whyItMatters": "string",    "whatXovrisDoes": "string",    "whatYouCanDo": [      "string"    ]  },  "reasons": [    "string"  ],  "assets": [    {      "address": "string",      "role": "string",      "node": {        "id": "string",        "name": "string",        "kind": "server",        "deviceId": "string"      }    }  ],  "timeline": [    {      "at": "string",      "kind": "state",      "words": "string",      "by": "string",      "decisionId": "string",      "proof": null    }  ],  "evidence": {    "lines": 1,    "first": "string",    "last": "string",    "blocked": 1,    "sensors": [      "string"    ],    "engines": [      "string"    ],    "integrity": {      "intact": true,      "chained": 1,      "unchained": 1,      "altered": 1,      "missing": 1,      "brokenLinks": 1,      "latest": {        "seq": 1,        "head": "string"      }    },    "digest": "string",    "how": "string"  },  "next": [    "string"  ]}

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.