Set how much of the time a check must be up
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.
const url = 'https://api.xovris.ai/v1/checks/example/promise';const options = { method: 'PUT', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"objective":null,"series":null}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PUT \ --url https://api.xovris.ai/v1/checks/example/promise \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "objective": null, "series": null }'Needs a token that can read and change. A token without change access is refused with token_read_only and the step to take.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Request Body
Section titled “Request Body”object
Example
{ "objective": null, "series": null}Responses
Section titled “Responses”Done.
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
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.
object
object
A stable code a program can branch on.
What happened, in plain words.
What to do next.
The recorded authorisation decision, when a role refused it.
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.
object
object
A stable code a program can branch on.
What happened, in plain words.
What to do next.
The recorded authorisation decision, when a role refused it.
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.
object
object
A stable code a program can branch on.
What happened, in plain words.
What to do next.
The recorded authorisation decision, when a role refused it.
Example generated
{ "error": { "code": "example", "message": "example", "nextStep": "example", "decisionId": "example" }}default
Section titled “default”Any other refusal or failure. The answer says what happened and what to do next.
object
object
A stable code a program can branch on.
What happened, in plain words.
What to do next.
The recorded authorisation decision, when a role refused it.
Example generated
{ "error": { "code": "example", "message": "example", "nextStep": "example", "decisionId": "example" }}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.