Skip to content

Read your setup's health

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/setup/health
curl --request GET \  --url https://api.xovris.ai/v1/setup/health \  --header 'Authorization: Bearer <token>'

A token that can read is enough.

Done.

Media typeapplication/json
object
state
required
string
Allowed values: live nothing_yet checks_running checks_only
checks
required
Array<object>
object
assetId
required
string
label
required
string
kind
required
string
Allowed values: tls https dns rdap
state
required
string
Allowed values: up degraded down running expired expiring blocked_by_site
storedAt
required
One of:
string
detail
required
One of:
string
nextCheckAt
required
One of:
string
apps
required
Array<object>
object
connectionId
required
string
label
required
string
traffic
required
string
Allowed values: receiving none_yet
firstStoredAt
required
One of:
string
requests
required
One of:
object
kind
required
string
Allowed values: measured
count
required
number
since
required
string
asOf
required
One of:
string
errors
required
One of:
object
kind
required
string
Allowed values: measured
count
required
number
since
required
string
asOf
required
One of:
string
alerts
required
Array<object>
object
channel
required
string
Allowed values: email slack
state
required
string
Allowed values: failed queued accepted delivered bounced not_sent
providerReference
required
One of:
string
at
required
One of:
string
failure
required
One of:
string
next
required
string
Allowed values: none add_url connect_app send_test_alert deploy_and_open_app

Example

{  "state": "live",  "checks": [    {      "assetId": "string",      "label": "string",      "kind": "tls",      "state": "up",      "storedAt": "string",      "detail": "string",      "nextCheckAt": "string"    }  ],  "apps": [    {      "connectionId": "string",      "label": "string",      "traffic": "receiving",      "firstStoredAt": "string",      "requests": {        "kind": "measured",        "count": 1,        "since": "string",        "asOf": "string"      },      "errors": {        "kind": "measured",        "count": 1,        "since": "string",        "asOf": "string"      }    }  ],  "alerts": [    {      "channel": "email",      "state": "failed",      "providerReference": "string",      "at": "string",      "failure": "string"    }  ],  "next": "none"}

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.