Skip to content

Connect the status page Xovris posts updates to

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/alerts/status-page-door/connect
curl --request POST \  --url https://api.xovris.ai/v1/alerts/status-page-door/connect \  --header 'Authorization: Bearer <token>' \  --header 'Content-Type: application/json' \  --data '{ "provider": null, "pageId": "string", "key": "string", "componentIds": [ null ], "dryRun": 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.

Media typeapplication/json
object
provider
pageId
string
key
string
componentIds
Array
dryRun

Example

{  "provider": null,  "pageId": "string",  "key": "string",  "componentIds": [    null  ],  "dryRun": null}

Done.

Media typeapplication/json
One of:
object
dryRun
required
boolean
wouldRead
required
object
method
required
string
Allowed values: GET POST DELETE
url
required
string
headers
required
Array<string>
bytes
required
number
wouldKeep
required
object
provider
required
string
Allowed values: statuspage instatus
pageId
required
string
componentIds
required
Array<string>
key
required
string

Example

{  "dryRun": true,  "wouldRead": {    "method": "GET",    "url": "string",    "headers": [      "string"    ],    "bytes": 1  },  "wouldKeep": {    "provider": "statuspage",    "pageId": "string",    "componentIds": [      "string"    ],    "key": "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.