Skip to content

See network incidents with their real risk and a plain explanation

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

A token that can read is enough.

Done.

Media typeapplication/json
object
items
required
Array<object>
object
id
required
string
fingerprint
required
string
signatureKey
required
string
name
required
string
src
required
string
dest
required
string
firstSeen
required
string
lastSeen
required
string
count
required
number
blocked
required
number
risk
required
number
level
required
string
state
required
string
suppressedBy
required
One of:
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>
explanation
required
object
headline
required
string
whatHappened
required
string
whyItMatters
required
string
whatXovrisDoes
required
string
whatYouCanDo
required
Array<string>
reasons
required
Array<string>
open
required
number

Example

{  "items": [    {      "id": "string",      "fingerprint": "string",      "signatureKey": "string",      "name": "string",      "src": "string",      "dest": "string",      "firstSeen": "string",      "lastSeen": "string",      "count": 1,      "blocked": 1,      "risk": 1,      "level": "string",      "state": "string",      "suppressedBy": "string",      "mitre": [        {          "tacticId": "string",          "tactic": "string",          "techniqueId": "string",          "technique": "string",          "inferred": true        }      ],      "cves": [        "string"      ],      "explanation": {        "headline": "string",        "whatHappened": "string",        "whyItMatters": "string",        "whatXovrisDoes": "string",        "whatYouCanDo": [          "string"        ]      },      "reasons": [        "string"      ]    }  ],  "open": 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.