Skip to content

Get the steps that rescue a device from what it is doing wrong

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/rescue-kit
curl --request POST \  --url https://api.xovris.ai/v1/rescue-kit \  --header 'Authorization: Bearer <token>' \  --header 'Content-Type: application/json' \  --data '{ "device": null, "symptom": 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
device
symptom

Example

{  "device": null,  "symptom": null}

Done.

Media typeapplication/json
object
media
required
One of:
object
name
required
string
from
required
string
sizeGb
required
number
bootKey
required
string
steps
required
Array<object>
object
by
required
string
Allowed values: person xovris
says
required
string
act
object
kind
required
string
Allowed values: snapshot rotate_key narrow_grant watch_mail start_clock switch_failover tell_users read_recovery_key find_cause turn_on_recovery prepare_media book_repair restore_backup prepare_loaner encrypt_disk install_updates turn_on_find_my back_up move_data cancel_subscription downgrade_subscription
key
required
string
door
required
boolean
target
required
object
key
additional properties
string
state
string
Allowed values: done refused ready undone on_your_go standing_by nothing_to_do
hardware
required
boolean
erasesData
required
boolean
whatXovrisDoes
required
string
doItYourself
required
string

Example

{  "media": {    "name": "string",    "from": "string",    "sizeGb": 1  },  "bootKey": "string",  "steps": [    {      "by": "person",      "says": "string",      "act": {        "kind": "snapshot",        "key": "string",        "door": true,        "target": {}      },      "state": "done"    }  ],  "hardware": true,  "erasesData": true,  "whatXovrisDoes": "string",  "doItYourself": "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.