Skip to content

Make a group of devices to watch and manage together

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.

POST
/v1/devices/groups
curl --request POST \  --url https://api.xovris.ai/v1/devices/groups \  --header 'Authorization: Bearer <token>' \  --header 'Content-Type: application/json' \  --data '{ "name": null, "preview": null, "include": null, "exclude": null, "rule": {}, "ruleMode": null, "healthEveryMinutes": null, "healthDailyAt": null, "includeAll": null, "id": "string" }'

Needs a token that can read and change. A token without change access is refused with token_read_only and the step to take.

Media typeapplication/json
object
name
preview
include
exclude
rule
object
ruleMode
healthEveryMinutes
healthDailyAt
includeAll
id
string

Example

{  "name": null,  "preview": null,  "include": null,  "exclude": null,  "rule": {},  "ruleMode": null,  "healthEveryMinutes": null,  "healthDailyAt": null,  "includeAll": null,  "id": "string"}

Done.

Media typeapplication/json
One of:
object
preview
required
boolean
group
required
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>

Example

{  "preview": true,  "group": {    "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"    ]  }}

Done: something new was made, and the answer is it.

Media typeapplication/json
object
group
required
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>

Example

{  "group": {    "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"    ]  }}

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.