Skip to content

Read a check's promise and its error budget

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

A token that can read is enough.

id
required
string

Done.

Media typeapplication/json
object
checkId
required
string
objective
required
One of:
number
setBy
required
One of:
string
setAt
required
One of:
string
window
required
string
Allowed values: 7d 30d 90d month week
windows
required
Array<string>
Allowed values: 7d 30d 90d month week
windowFrom
required
string
uptime30d
required
One of:
number
uptime
required
One of:
number
days
required
Array<object>
object
date
required
string
uptime
required
One of:
number
measuredSince
required
One of:
string
budget
required
One of:
object
allowedMinutes
required
number
usedMinutes
required
number
leftMinutes
required
number
kept
required
boolean
burn
required
One of:
number
runsOutAt
required
One of:
string
sentence
required
string
pace
required
One of:
string
choices
required
Array
series
required
One of:
object
kind
required
string
Allowed values: up
alerts
required
Array<object>
object
id
required
string
own
required
boolean
severity
required
string
Allowed values: page ticket
burn
required
number
longMinutes
required
number
shortMinutes
required
number
longBurn
required
number
shortBurn
required
number
firing
required
boolean
runs
required
number
burnMost
required
One of:
number
longHoursMost
required
number
groups
required
Array<object>
object
good
required
number
total
required
number
left
required
One of:
number
name
required
string
uptime
required
One of:
number
burndown
required
Array<object>
object
date
required
string
left
required
number
corrections
required
Array<object>
object
id
required
string
from
required
string
to
required
string
kind
required
string
Allowed values: other maintenance deployment outside_hours
note
required
One of:
string
every
required
One of:
string
Allowed values: month week day
until
required
One of:
string
setBy
required
One of:
string
setAt
required
One of:
string
excludedMinutes
required
number
correctionKinds
required
Array
empty
required
One of:
string

Example

{  "checkId": "string",  "objective": 1,  "setBy": "string",  "setAt": "string",  "window": "7d",  "windows": [    "7d"  ],  "windowFrom": "string",  "uptime30d": 1,  "uptime": 1,  "days": [    {      "date": "string",      "uptime": 1    }  ],  "measuredSince": "string",  "budget": {    "allowedMinutes": 1,    "usedMinutes": 1,    "leftMinutes": 1,    "kept": true,    "burn": 1,    "runsOutAt": "string",    "sentence": "string",    "pace": "string"  },  "choices": [    99.99  ],  "series": {    "kind": "up"  },  "alerts": [    {      "id": "string",      "own": true,      "severity": "page",      "burn": 1,      "longMinutes": 1,      "shortMinutes": 1,      "longBurn": 1,      "shortBurn": 1,      "firing": true,      "runs": 1    }  ],  "burnMost": 1,  "longHoursMost": 1,  "groups": [    {      "good": 1,      "total": 1,      "left": 1,      "name": "string",      "uptime": 1    }  ],  "burndown": [    {      "date": "string",      "left": 1    }  ],  "corrections": [    {      "id": "string",      "from": "string",      "to": "string",      "kind": "other",      "note": "string",      "every": "month",      "until": "string",      "setBy": "string",      "setAt": "string"    }  ],  "excludedMinutes": 1,  "correctionKinds": [    "maintenance"  ],  "empty": "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.