Planned work on a status page moved, changed, ended early ({ end: true }) or called off ({ cancel: true }) - its followers told and its held alerts moved with it
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/status-pages/example/maintenance/example';const options = { method: 'PUT', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"title":null,"body":null,"parts":null,"startsAt":null,"endsAt":null,"holdAlerts":null,"idempotencyKey":null,"end":null,"cancel":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/status-pages/example/maintenance/example \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "title": null, "body": null, "parts": null, "startsAt": null, "endsAt": null, "holdAlerts": null, "idempotencyKey": null, "end": null, "cancel": 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
{ "title": null, "body": null, "parts": null, "startsAt": null, "endsAt": null, "holdAlerts": null, "idempotencyKey": null, "end": null, "cancel": null}Responses
Section titled “Responses”Done.
object
Example
{ "alertsWhy": "string", "why": "string", "ok": true, "maintenance": { "alertsHeld": true, "id": "string", "title": "string", "body": "string", "parts": [ "string" ], "startsAt": "string", "endsAt": "string", "state": "string" }, "again": true, "emailed": 1}Done.
object
Example
{ "alertsWhy": "string", "why": "string", "ok": true, "maintenance": { "alertsHeld": true, "id": "string", "title": "string", "body": "string", "parts": [ "string" ], "startsAt": "string", "endsAt": "string", "state": "string" }, "again": true, "emailed": 1}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.