Skip to content

See who and what the business depends on, so nothing stops when one person is away

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/continuity
curl --request POST \  --url https://api.xovris.ai/v1/continuity \  --header 'Authorization: Bearer <token>' \  --header 'Content-Type: application/json' \  --data '{ "access": null, "actions": null, "runbooks": null, "files": [ null ], "people": null, "leaving": null, "learnRate": 1, "filter": {} }'

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
access
actions
runbooks
files
Array
people
leaving
learnRate
number
filter
object

Example

{  "access": null,  "actions": null,  "runbooks": null,  "files": [    null  ],  "people": null,  "leaving": null,  "learnRate": 1,  "filter": {}}

Done.

Media typeapplication/json
object
code
object
areas
required
Array<object>
object
area
required
string
lines
required
number
owners
required
Array<object>
object
name
required
string
share
required
number
busFactor
required
number
health
required
One of:
number
island
required
boolean
formerShare
required
number
risk
required
string
Allowed values: ok high watch
languages
required
Array<string>
offboarding
required
object
people
required
Array<string>
loses
required
Array<object>
object
area
required
string
share
required
number
formerLoss
required
Array<object>
object
month
required
string
share
required
number
onboard
required
Array<object>
object
area
required
string
from
required
string
to
required
One of:
string
whileHere
required
boolean
refactorFirst
required
Array<object>
object
area
required
string
health
required
number
busFactor
required
number
pair
required
Array
toLearn
required
Array<object>
object
area
required
string
lines
required
number
files
required
number
hours
required
One of:
number
sprawl
required
Array<object>
object
area
required
string
languages
required
number
atRisk
required
boolean
guide
required
string
people
required
Array<object>
object
name
required
string
team
required
One of:
string
former
required
boolean
holds
required
Array<string>
whatXovrisDoes
required
string
doItYourself
required
string
atRisk
required
Array<object>
object
system
required
string
gaps
required
Array<string>
Allowed values: one_admin one_doer no_runbook runbook_stale no_break_glass
onlyPerson
required
One of:
string
critical
required
boolean
says
required
string
capture
required
Array<string>
ifLeaves
required
object
key
additional properties
Array<string>
whatXovrisDoes
required
string
doItYourself
required
string

Example

{  "code": {    "areas": [      {        "area": "string",        "lines": 1,        "owners": [          {            "name": "string",            "share": 1          }        ],        "busFactor": 1,        "health": 1,        "island": true,        "formerShare": 1,        "risk": "ok",        "languages": [          "string"        ]      }    ],    "offboarding": {      "people": [        "string"      ],      "loses": [        {          "area": "string",          "share": 1        }      ]    },    "formerLoss": [      {        "month": "string",        "share": 1      }    ],    "onboard": [      {        "area": "string",        "from": "string",        "to": "string",        "whileHere": true      }    ],    "refactorFirst": [      {        "area": "string",        "health": 1,        "busFactor": 1,        "pair": [          "string"        ]      }    ],    "toLearn": [      {        "area": "string",        "lines": 1,        "files": 1,        "hours": 1      }    ],    "sprawl": [      {        "area": "string",        "languages": 1,        "atRisk": true,        "guide": "string"      }    ],    "people": [      {        "name": "string",        "team": "string",        "former": true,        "holds": [          "string"        ]      }    ],    "whatXovrisDoes": "string",    "doItYourself": "string"  },  "atRisk": [    {      "system": "string",      "gaps": [        "one_admin"      ],      "onlyPerson": "string",      "critical": true,      "says": "string",      "capture": [        "string"      ]    }  ],  "ifLeaves": {},  "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.