Skip to content

Add a check

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

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

Example generated

{}

Done.

Media typeapplication/json
One of:
object
ok
required
boolean
dryRun
required
boolean
check
required
object
understood
required
Array<string>
notUnderstood
required
Array<string>
witness
string
kind
required
string
Allowed values: api website journey
name
required
string
target
required
string
schedule
required
One of:
string
Allowed values: continuous
every
required
string
intervalMs
required
number
locations
required
Array<string>
cadence
required
object
why
required
string
asked
required
One of:
string
Allowed values: continuous
faster
required
One of:
string
upgrade
required
One of:
string

Example

{  "ok": true,  "dryRun": true,  "check": {    "understood": [      "string"    ],    "notUnderstood": [      "string"    ],    "witness": "string",    "kind": "api",    "name": "string",    "target": "string",    "schedule": "continuous",    "every": "string",    "intervalMs": 1,    "locations": [      "string"    ],    "cadence": {      "why": "string",      "asked": "continuous",      "faster": "string",      "upgrade": "string"    }  }}

Done: something new was made, and the answer is it.

Media typeapplication/json
One of:
object
next
required
string
moved
object
secret
required
string
words
required
string
ok
required
boolean
created
required
boolean
check
required
object
understood
required
Array<string>
notUnderstood
required
Array<string>
witness
string
kind
required
string
Allowed values: api website journey
name
required
string
target
required
string
schedule
required
One of:
string
Allowed values: continuous
every
required
string
intervalMs
required
number
locations
required
Array<string>
cadence
required
object
why
required
string
asked
required
One of:
string
Allowed values: continuous
faster
required
One of:
string
upgrade
required
One of:
string
id
required
string

Example

{  "next": "string",  "moved": {    "secret": "string",    "words": "string"  },  "ok": true,  "created": true,  "check": {    "understood": [      "string"    ],    "notUnderstood": [      "string"    ],    "witness": "string",    "kind": "api",    "name": "string",    "target": "string",    "schedule": "continuous",    "every": "string",    "intervalMs": 1,    "locations": [      "string"    ],    "cadence": {      "why": "string",      "asked": "continuous",      "faster": "string",      "upgrade": "string"    },    "id": "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.