Skip to content

Start emergency mode: an incident, the records preserved, the steps and the people paged

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/security/emergency
curl --request POST \  --url https://api.xovris.ai/v1/security/emergency \  --header 'Authorization: Bearer <token>' \  --header 'Content-Type: application/json' \  --data '{ "kind": null, "detail": "string" }'

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
kind
detail
string

Example

{  "kind": null,  "detail": "string"}

Done.

Media typeapplication/json
object
told
required
object
paged
required
boolean
why
required
string
incidentId
required
string
again
required
boolean
kind
required
string
Allowed values: unlisted hacked ransomware defaced locked_out
title
required
string
contain
required
Array<object>
object
step
required
string
why
required
string
preserved
required
Array<object>
object
kind
required
string
items
required
number
digest
required
string
observedAt
required
string
restore
required
Array<object>
object
what
required
string
available
required
boolean
how
required
string

Example

{  "told": {    "paged": true,    "why": "string"  },  "incidentId": "string",  "again": true,  "kind": "unlisted",  "title": "string",  "contain": [    {      "step": "string",      "why": "string"    }  ],  "preserved": [    {      "kind": "string",      "items": 1,      "digest": "string",      "observedAt": "string"    }  ],  "restore": [    {      "what": "string",      "available": true,      "how": "string"    }  ]}

Done: something new was made, and the answer is it.

Media typeapplication/json
object
told
required
object
paged
required
boolean
why
required
string
incidentId
required
string
again
required
boolean
kind
required
string
Allowed values: unlisted hacked ransomware defaced locked_out
title
required
string
contain
required
Array<object>
object
step
required
string
why
required
string
preserved
required
Array<object>
object
kind
required
string
items
required
number
digest
required
string
observedAt
required
string
restore
required
Array<object>
object
what
required
string
available
required
boolean
how
required
string

Example

{  "told": {    "paged": true,    "why": "string"  },  "incidentId": "string",  "again": true,  "kind": "unlisted",  "title": "string",  "contain": [    {      "step": "string",      "why": "string"    }  ],  "preserved": [    {      "kind": "string",      "items": 1,      "digest": "string",      "observedAt": "string"    }  ],  "restore": [    {      "what": "string",      "available": true,      "how": "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.