Skip to content

Verify a connection is working

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

A token that can read is enough.

id
required
string

Done.

Media typeapplication/json
object
connectionId
required
string
now
required
string
ladder
required
object
connectionId
required
string
kind
required
string
Allowed values: email url system mcp slack vercel cloudflare sdk
label
required
string
platform
required
One of:
string
rungs
required
Array<object>
object
rung
required
string
Allowed values: connected repair_authorised telemetry_received monitoring_verified
reached
required
boolean
at
required
One of:
string
applicable
required
boolean
current
required
One of:
string
Allowed values: connected repair_authorised telemetry_received monitoring_verified
capabilities
required
Array<string>
Allowed values: watch receive_events dns_record_edit deploy_env_write post_messages
writes
boolean
health
required
string
Allowed values: revoked waiting healthy credential_failed
diagnosis
required
One of:
string
Allowed values: unknown wrong_key blocked_egress ad_blocked_browser unsupported_runtime build_token_missing token_revoked scope_missing
canary
One of:
object
outcome
required
string
status
required
One of:
number
detail
required
One of:
string
at
required
string
nextDueAt
required
One of:
string
everySeconds
required
One of:
number
buildToken
One of:
object
at
required
string
events
required
number
code
required
string
Allowed values: build_token_missing
cause
required
string
next
required
string
fix
required
object
label
required
string
method
required
string
path
required
string
body
required
object
key
additional properties
browserBlocked
One of:
object
at
required
string
envelopes
required
number
code
required
string
Allowed values: ad_blocked_browser
cause
required
string
next
required
string
environmentWarning
One of:
object
at
required
string
events
required
number
code
required
string
Allowed values: tag_disagrees_with_key production_tag_from_preview_host release_never_in_production
tagged
required
string
actual
required
One of:
string
release
required
One of:
string
host
required
One of:
string
cause
required
string
next
required
string
fix
required
One of:
object
label
required
string
method
required
string
path
required
string
body
required
object
key
additional properties
environmentMap
Array<object>
object
project
required
string
target
required
string
readBackAt
required
One of:
string
release
required
One of:
string
releasedAt
required
One of:
string
url
required
One of:
string
telemetryReceived
required
boolean
monitoringVerified
required
boolean
testEventStoredAt
required
One of:
string
firstEventStoredAt
required
One of:
string
lastEventStoredAt
required
One of:
string
diagnosis
required
One of:
string
Allowed values: unknown wrong_key blocked_egress ad_blocked_browser unsupported_runtime build_token_missing token_revoked scope_missing

Example

{  "connectionId": "string",  "now": "string",  "ladder": {    "connectionId": "string",    "kind": "email",    "label": "string",    "platform": "string",    "rungs": [      {        "rung": "connected",        "reached": true,        "at": "string",        "applicable": true      }    ],    "current": "connected",    "capabilities": [      "watch"    ],    "writes": true,    "health": "revoked",    "diagnosis": "unknown",    "canary": {      "outcome": "string",      "status": 1,      "detail": "string",      "at": "string",      "nextDueAt": "string",      "everySeconds": 1    },    "buildToken": {      "at": "string",      "events": 1,      "code": "build_token_missing",      "cause": "string",      "next": "string",      "fix": {        "label": "string",        "method": "string",        "path": "string",        "body": {}      }    },    "browserBlocked": {      "at": "string",      "envelopes": 1,      "code": "ad_blocked_browser",      "cause": "string",      "next": "string"    },    "environmentWarning": {      "at": "string",      "events": 1,      "code": "tag_disagrees_with_key",      "tagged": "string",      "actual": "string",      "release": "string",      "host": "string",      "cause": "string",      "next": "string",      "fix": {        "label": "string",        "method": "string",        "path": "string",        "body": {}      }    },    "environmentMap": [      {        "project": "string",        "target": "string",        "readBackAt": "string",        "release": "string",        "releasedAt": "string",        "url": "string"      }    ]  },  "telemetryReceived": true,  "monitoringVerified": true,  "testEventStoredAt": "string",  "firstEventStoredAt": "string",  "lastEventStoredAt": "string",  "diagnosis": "unknown"}

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.