Skip to content

List your cloud accounts and how far each connection has got

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

A token that can read is enough.

Done.

Media typeapplication/json
object
connections
required
Array<object>
object
id
required
string
provider
required
string
Allowed values: gcp aws azure
scope
required
string
Allowed values: account organisation
rung
required
string
Allowed values: first_data read_back link_ready role_created
diff
required
One of:
object
equal
required
boolean
missing
required
Array<string>
extra
required
Array<string>
link
required
One of:
string
failure
required
One of:
object
code
required
string
message
required
string
next
required
string
at
required
One of:
string
accountId
required
One of:
string
region
required
One of:
string
roleArn
required
One of:
string
firstRead
required
One of:
object
key
additional properties
createdAt
required
One of:
string
access
required
string
Allowed values: read change
changeKinds
required
Array<string>
published
required
Array<string>
connection
required
One of:
string
met
required
Array<object>
object
connectionId
required
string
provider
required
string
title
required
string
met
required
boolean
providers
required
object
key
additional properties
object
ready
required
boolean
empty
required
One of:
string

Example

{  "connections": [    {      "id": "string",      "provider": "gcp",      "scope": "account",      "rung": "first_data",      "diff": {        "equal": true,        "missing": [          "string"        ],        "extra": [          "string"        ]      },      "link": "string",      "failure": {        "code": "string",        "message": "string",        "next": "string"      },      "at": "string",      "accountId": "string",      "region": "string",      "roleArn": "string",      "firstRead": {},      "createdAt": "string",      "access": "read",      "changeKinds": [        "string"      ],      "published": [        "string"      ],      "connection": "string"    }  ],  "met": [    {      "connectionId": "string",      "provider": "string",      "title": "string",      "met": true    }  ],  "providers": {},  "empty": "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.