Skip to content

See what a supplier's incident means for you, and have Xovris act on it

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/suppliers/impact
curl --request POST \  --url https://api.xovris.ai/v1/suppliers/impact \  --header 'Authorization: Bearer <token>' \  --header 'Content-Type: application/json' \  --data '{ "event": { "supplier": "string", "kind": "degraded", "at": "string", "source": "string", "exposed": [ "string" ] }, "ties": null, "go": 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
event
object
supplier
required
string
kind
required
string
Allowed values: degraded breach outage ransomware shutdown
at
required
string
source
required
string
exposed
Array<string>
ties
go

Example

{  "event": {    "supplier": "string",    "kind": "degraded",    "at": "string",    "source": "string",    "exposed": [      "string"    ]  },  "ties": null,  "go": null}

Done.

Media typeapplication/json
One of:
object
affected
required
boolean
ties
required
Array<object>
object
supplier
required
string
kind
required
string
Allowed values: email dns sso saas payment hosting api_key oauth_grant data_processor
system
One of:
string
data
Array<string>
doorHeld
boolean
failover
One of:
string
from
string
Allowed values: record you
ref
object
key
additional properties
string
means
required
string
actions
required
Array
One of:
object
by
required
string
Allowed values: xovris
does
required
string
act
required
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
required
string
Allowed values: done refused ready undone on_your_go standing_by nothing_to_do
says
required
string
readBack
One of:
string
undo
One of:
string
gdprClock
required
One of:
object
startsAt
required
string
dueBy
required
string
personalData
required
object
state
required
string
Allowed values: none unread personal
labels
required
Array<string>
why
string
whatXovrisDoes
required
string
doItYourself
required
string

Example

{  "affected": true,  "ties": [    {      "supplier": "string",      "kind": "email",      "system": "string",      "data": [        "string"      ],      "doorHeld": true,      "failover": "string",      "from": "record",      "ref": {}    }  ],  "means": "string",  "actions": [    {      "by": "xovris",      "does": "string",      "act": {        "kind": "snapshot",        "key": "string",        "door": true,        "target": {}      },      "state": "done",      "says": "string",      "readBack": "string",      "undo": "string"    }  ],  "gdprClock": {    "startsAt": "string",    "dueBy": "string"  },  "personalData": {    "state": "none",    "labels": [      "string"    ],    "why": "string"  },  "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.