Skip to content

Check a cloud connection's access again

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/cloud/connections/{id}/check
curl --request POST \  --url https://api.xovris.ai/v1/cloud/connections/example/check \  --header 'Authorization: Bearer <token>' \  --header 'Content-Type: application/json' \  --data '{}'

Needs a token that can read and change. A token without change access is refused with token_read_only and the step to take.

id
required
string
Media typeapplication/json
object

Example generated

{}

Done.

Media typeapplication/json
One of:
object
connection
required
object
connectionId
required
string
provider
required
string
title
required
string
met
required
boolean
rung
required
string
Allowed values: first_data read_back
firstRead
required
object
running
required
One of:
object
kind
required
string
count
required
number
costs
required
One of:
object
kind
required
string
items
required
number
total
required
One of:
number
currency
required
One of:
string
at
required
string
grant
required
object
granted
required
One of:
Array<string>
readFrom
required
One of:
string
failure
required
One of:
string

Example

{  "connection": {    "connectionId": "string",    "provider": "string",    "title": "string",    "met": true,    "rung": "first_data",    "firstRead": {      "running": {        "kind": "string",        "count": 1      },      "costs": {        "kind": "string",        "items": 1,        "total": 1,        "currency": "string"      },      "at": "string"    },    "grant": {      "granted": [        "string"      ],      "readFrom": "string"    },    "failure": "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.