Skip to content

Read every cause Xovris is weighing for an incident and what tested each

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

A token that can read is enough.

id
required
string

Done.

Media typeapplication/json
object
status
required
string
Allowed values: paused running empty concluded
families
required
Array<object>
object
family
required
One of:
string
Allowed values: data
words
required
string
causes
required
Array<object>
object
id
required
string
title
required
string
state
required
string
Allowed values: open supported refuted inconclusive survived untestable
words
required
string
tests
required
number
ruledOut
required
Array<object>
object
cause
required
string
says
required
string
changes
required
One of:
object
allowed
required
boolean
why
required
string
paused
required
One of:
object
why
required
string
waitingFor
required
Array<string>
resumedBy
required
number
checks
required
Array<object>
object
id
required
string
family
required
One of:
string
confirmed
required
One of:
boolean

Example

{  "status": "paused",  "families": [    {      "family": "data",      "words": "string",      "causes": [        {          "id": "string",          "title": "string",          "state": "open",          "words": "string",          "tests": 1        }      ]    }  ],  "ruledOut": [    {      "cause": "string",      "says": "string"    }  ],  "changes": {    "allowed": true,    "why": "string"  },  "paused": {    "why": "string",    "waitingFor": [      "string"    ]  },  "resumedBy": 1,  "checks": [    {      "id": "string",      "family": "string",      "confirmed": true    }  ]}

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.