Skip to content

Erase this workspace and everything in it, with a signed receipt

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/workspace/erase
curl --request POST \  --url https://api.xovris.ai/v1/workspace/erase \  --header 'Authorization: Bearer <token>' \  --header 'Content-Type: application/json' \  --data '{ "confirm": 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
confirm

Example

{  "confirm": null}

Done.

Media typeapplication/json
object
erased
required
boolean
receipt
required
object
id
required
string
workspaceHash
required
string
erased
required
object
key
additional properties
number
keptByLaw
required
Array<object>
object
table
required
string
until
required
string
rule
required
string
left
required
object
key
additional properties
string
why
required
string
Allowed values: asked dormant
erasedAt
required
string
backupsClearBy
required
string
mac
required
string

Example

{  "erased": true,  "receipt": {    "id": "string",    "workspaceHash": "string",    "erased": {},    "keptByLaw": [      {        "table": "string",        "until": "string",        "rule": "string"      }    ],    "left": {},    "why": "asked",    "erasedAt": "string",    "backupsClearBy": "string",    "mac": "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.