Skip to content

Read a connection's credential state

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

A token that can read is enough.

id
required
string

Done.

Media typeapplication/json
object
connectionId
required
string
kind
required
string
Allowed values: email url system mcp slack vercel cloudflare sdk
owner
required
One of:
string
reassignmentFlaggedAt
required
One of:
string
health
required
string
revokedAt
required
One of:
string
credentialError
required
One of:
object
code
required
string
Allowed values: unknown wrong_key blocked_egress ad_blocked_browser unsupported_runtime build_token_missing token_revoked scope_missing
at
required
string
rotation
required
One of:
object
startedAt
required
string
newKeyFirstEventAt
required
One of:
string
oldKeysLastEventAt
required
One of:
string
quietMs
required
number
cycleMs
required
number

Example

{  "connectionId": "string",  "kind": "email",  "owner": "string",  "reassignmentFlaggedAt": "string",  "health": "string",  "revokedAt": "string",  "credentialError": {    "code": "unknown",    "at": "string"  },  "rotation": {    "startedAt": "string",    "newKeyFirstEventAt": "string",    "oldKeysLastEventAt": "string",    "quietMs": 1  },  "cycleMs": 1}

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.