Skip to content

Read how a connection's scheduled check went

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

A token that can read is enough.

id
required
string

Done.

Media typeapplication/json
object
connection
required
object
id
required
string
source
required
string
Allowed values: logs setup tool recipe canary
provider
required
string
title
required
string
canary
required
One of:
object
id
required
string
state
required
string
Allowed values: unknown passing failing
outcome
required
One of:
string
Allowed values: token refused unavailable scope contract pass
status
required
One of:
number
detail
required
One of:
string
at
required
One of:
string
nextDueAt
required
string
everySeconds
required
number
consecutiveFailures
required
number
repair
required
One of:
object
id
required
string
reason
required
string
Allowed values: token scope contract
openedAt
required
string
origin
string
Allowed values: canary nightly
hold
One of:
object
kind
required
string
Allowed values: source_changed nightly_failed
since
required
string
sourceUrl
required
One of:
string
words
required
string
next
required
One of:
string

Example

{  "connection": {    "id": "string",    "source": "logs",    "provider": "string",    "title": "string"  },  "canary": {    "id": "string",    "state": "unknown",    "outcome": "token",    "status": 1,    "detail": "string",    "at": "string",    "nextDueAt": "string",    "everySeconds": 1,    "consecutiveFailures": 1,    "repair": {      "id": "string",      "reason": "token",      "openedAt": "string",      "origin": "canary"    },    "hold": {      "kind": "source_changed",      "since": "string",      "sourceUrl": "string"    },    "words": "string",    "next": "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.