Skip to content

Replay an incident moment by moment: every system's state, the first sign, and the minutes to detect, mitigate and verify

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.

POST
/v1/incidents/replay
curl --request POST \  --url https://api.xovris.ai/v1/incidents/replay \  --header 'Authorization: Bearer <token>' \  --header 'Content-Type: application/json' \  --data '{ "events": null }'

Needs a token that can read and change. A token without change access is refused with token_read_only and the step to take.

Media typeapplication/json
object
events

Example

{  "events": null}

Done.

Media typeapplication/json
object
frames
required
Array<object>
object
at
required
string
states
required
object
key
additional properties
string
Allowed values: ok degraded down
worst
required
One of:
string
Allowed values: ok degraded down
events
required
Array<object>
object
asset
required
string
kind
required
string
Allowed values: verified mitigated signal fixed detected note acknowledged
says
required
string
frameCount
required
number
dropped
required
number
impacted
required
Array<string>
firstSign
required
One of:
string
detected
required
One of:
string
mitigated
required
One of:
string
verified
required
One of:
string
minutes
required
object
signToDetect
required
One of:
number
detectToMitigate
required
One of:
number
mitigateToVerify
required
One of:
number
total
required
One of:
number
longestDown
required
One of:
object
asset
required
string
minutes
required
number
words
required
string

Example

{  "frames": [    {      "at": "string",      "states": {},      "worst": "ok",      "events": [        {          "asset": "string",          "kind": "verified",          "says": "string"        }      ]    }  ],  "frameCount": 1,  "dropped": 1,  "impacted": [    "string"  ],  "firstSign": "string",  "detected": "string",  "mitigated": "string",  "verified": "string",  "minutes": {    "signToDetect": 1,    "detectToMitigate": 1,    "mitigateToVerify": 1,    "total": 1  },  "longestDown": {    "asset": "string",    "minutes": 1  },  "words": "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.