Skip to content

List log connections

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

A token that can read is enough.

Done.

Media typeapplication/json
object
items
required
Array<object>
object
lastDay
required
object
received
required
number
stored
required
number
failed
required
number
dropped
required
number
id
required
string
adapter
required
string
name
required
string
row
required
One of:
string
settings
required
object
key
additional properties
string
status
required
string
Allowed values: paused connected
createdAt
required
string
lastDeliveryAt
required
One of:
string
deliveries
required
number
refusals
required
number
lastRefusal
required
One of:
object
reason
required
string
at
required
One of:
string
secretSealed
required
boolean
setup
required
One of:
object
address
required
string
auth
required
string
Allowed values: key github gitlab stripe vercel learned logpush osquery
secretFrom
required
string
Allowed values: xovris sender
steps
required
string
addedToSender
required
One of:
object
at
required
string
readBack
required
boolean
addWhy
required
One of:
string
state
required
string
adapters
required
Array<object>
object
id
required
string
name
required
string
row
required
string
catalogue
required
string
auth
required
string
Allowed values: key github gitlab stripe vercel learned logpush osquery
secretFrom
required
string
Allowed values: xovris sender
settings
required
Array<string>
steps
required
string
observed
required
Array<object>
object
id
required
string
name
required
string
row
required
string
how
required
string

Example

{  "items": [    {      "lastDay": {        "received": 1,        "stored": 1,        "failed": 1,        "dropped": 1      },      "id": "string",      "adapter": "string",      "name": "string",      "row": "string",      "settings": {},      "status": "paused",      "createdAt": "string",      "lastDeliveryAt": "string",      "deliveries": 1,      "refusals": 1,      "lastRefusal": {        "reason": "string",        "at": "string"      },      "secretSealed": true,      "setup": {        "address": "string",        "auth": "key",        "secretFrom": "xovris",        "steps": "string"      },      "addedToSender": {        "at": "string",        "readBack": true      },      "addWhy": "string",      "state": "string"    }  ],  "adapters": [    {      "id": "string",      "name": "string",      "row": "string",      "catalogue": "string",      "auth": "key",      "secretFrom": "xovris",      "settings": [        "string"      ],      "steps": "string"    }  ],  "observed": [    {      "id": "string",      "name": "string",      "row": "string",      "how": "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.