Skip to content

List the devices your security tools see

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

A token that can read is enough.

Done.

Media typeapplication/json
object
devices
required
Array<object>
object
connectionId
required
string
deviceId
required
string
name
required
string
os
required
One of:
string
osVersion
required
One of:
string
contained
required
One of:
boolean
health
required
One of:
string
lastSeen
required
One of:
string
readAt
required
string
asset
required
string
comparison
required
Array<object>
object
connectionId
required
string
deviceId
required
string
name
required
string
agreed
required
Array<string>
onlyVendor
required
Array<string>
onlyXovris
required
Array<string>

Example

{  "devices": [    {      "connectionId": "string",      "deviceId": "string",      "name": "string",      "os": "string",      "osVersion": "string",      "contained": true,      "health": "string",      "lastSeen": "string",      "readAt": "string",      "asset": "string"    }  ],  "comparison": [    {      "connectionId": "string",      "deviceId": "string",      "name": "string",      "agreed": [        "string"      ],      "onlyVendor": [        "string"      ],      "onlyXovris": [        "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.