Skip to content

Read a watch

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

A token that can read is enough.

id
required
string

Done.

Media typeapplication/json
object
watch
required
object
id
required
string
kind
required
string
Allowed values: heartbeat payment backup uptime certificate dns_record date deploy signin latency metric domain_expiry page_text page_change email_auth mail_forwarding log_pattern cloud_change device_offline supplier_status
sentence
required
string
status
required
string
Allowed values: on off
watches
required
string
source
required
string
observedByXovris
required
boolean
firing
required
boolean
now
required
string
lastLookedAt
required
One of:
string
lastTestedAt
required
One of:
string
nextLookAt
required
string
createdAt
required
string
createdBy
required
string
fix
required
One of:
object
label
required
string
method
required
string
path
required
string
keptVersion
required
string
history
required
Array<object>
object
at
required
string format: date-time
kind
required
string
Allowed values: gap created test off fired cleared ping
sentence
required
string
fingerprint
required
One of:
string
detail
required
object
key
additional properties

Example

{  "watch": {    "id": "string",    "kind": "heartbeat",    "sentence": "string",    "status": "on",    "watches": "string",    "source": "string",    "observedByXovris": true,    "firing": true,    "now": "string",    "lastLookedAt": "string",    "lastTestedAt": "string",    "nextLookAt": "string",    "createdAt": "string",    "createdBy": "string",    "fix": {      "label": "string",      "method": "string",      "path": "string",      "keptVersion": "string"    }  },  "history": [    {      "at": "2026-10-20T09:30:00.000Z",      "kind": "gap",      "sentence": "string",      "fingerprint": "string",      "detail": {}    }  ]}

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.