Skip to content

See where a device change stands - its plan, its backup and what the device reads back

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

A token that can read is enough.

checkId
required
string

Done.

Media typeapplication/json
object
auto
required
boolean
plan
required
One of:
object
before
required
after
required
words
required
path
required
door
required
leaves
required
backup
required
One of:
object
at
required
sha256
required
bytes
required
text
required
string
done
required
One of:
object
state
required
readBack
required
held
required
undo
required
at
required
string
stage
required
string
Allowed values: verified refused failed planned same planning making put_back
words
required
string
checkId
required
string
kind
required
string
address
required
change
required

Example

{  "auto": true,  "plan": {    "before": null,    "after": null,    "words": null,    "path": null,    "door": null,    "leaves": null,    "backup": {      "at": null,      "sha256": null,      "bytes": null,      "text": "string"    }  },  "done": {    "state": null,    "readBack": null,    "held": null,    "undo": null  },  "at": "string",  "stage": "verified",  "words": "string",  "checkId": "string",  "kind": "string",  "address": null,  "change": null}

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.