Skip to content

List your device groups

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

A token that can read is enough.

Done.

Media typeapplication/json
object
items
required
Array<object>
object
id
required
string
name
required
string
includeAll
required
boolean
include
required
Array<object>
object
id
required
string
name
required
One of:
string
exclude
required
Array<object>
object
id
required
string
name
required
One of:
string
rule
required
One of:
object
all
required
Array
ruleText
required
One of:
string
ruleMode
required
string
Allowed values: include exclude
healthEveryMinutes
required
One of:
number
healthDailyAt
required
One of:
string
members
required
Array<object>
object
id
required
string
name
required
string
kind
required
string
os
required
string
memberCount
required
number
admins
required
Array<string>
properties
required
Array
empty
required
One of:
string

Example

{  "items": [    {      "id": "string",      "name": "string",      "includeAll": true,      "include": [        {          "id": "string",          "name": "string"        }      ],      "exclude": [        {          "id": "string",          "name": "string"        }      ],      "rule": {        "all": [          null        ]      },      "ruleText": "string",      "ruleMode": "include",      "healthEveryMinutes": 1,      "healthDailyAt": "string",      "members": [        {          "id": "string",          "name": "string",          "kind": "string",          "os": "string"        }      ],      "memberCount": 1,      "admins": [        "string"      ]    }  ],  "properties": [    "os"  ],  "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.