Skip to content

List what Xovris read by itself, and what it found

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

A token that can read is enough.

Done.

Media typeapplication/json
object
readings
required
Array<object>
object
id
required
string
subjectKind
required
string
Allowed values: connection asset dependency goal
subjectRef
required
string
trigger
required
string
Allowed values: connection incident cadence goal advisory inventory telemetry
wokenBy
required
Array<string>
words
required
One of:
string
state
required
string
Allowed values: reading failed found due healthy not_assessed
dueAt
required
string
readAt
required
One of:
string
nextAt
required
One of:
string
assessment
required
One of:
object
key
additional properties
lead
required
One of:
object
key
additional properties
fingerprint
required
One of:
string
incidentId
required
One of:
string

Example

{  "readings": [    {      "id": "string",      "subjectKind": "connection",      "subjectRef": "string",      "trigger": "connection",      "wokenBy": [        "string"      ],      "words": "string",      "state": "reading",      "dueAt": "string",      "readAt": "string",      "nextAt": "string",      "assessment": {},      "lead": {},      "fingerprint": "string",      "incidentId": "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.