Skip to content

Make a code to add a device

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

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

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

Media typeapplication/json
object
code
required
string
installer
required
One of:
object
key
additional properties
string
installerFacts
required
One of:
object
linux
object
signed
required
string
Allowed values: none authenticode notarised
bytes
required
One of:
number
sha256
required
One of:
string
arch
required
One of:
string
Allowed values: x64 arm64
windows
object
signed
required
string
Allowed values: none authenticode notarised
bytes
required
One of:
number
sha256
required
One of:
string
arch
required
One of:
string
Allowed values: x64 arm64
macos
object
signed
required
string
Allowed values: none authenticode notarised
bytes
required
One of:
number
sha256
required
One of:
string
arch
required
One of:
string
Allowed values: x64 arm64
expiresAt
required
string
shownOnce
required
string
enrol
required
object
windows
required
string
macos
required
string
linux
required
string

Example

{  "code": "string",  "installer": {},  "installerFacts": {    "linux": {      "signed": "none",      "bytes": 1,      "sha256": "string",      "arch": "x64"    },    "windows": {      "signed": "none",      "bytes": 1,      "sha256": "string",      "arch": "x64"    },    "macos": {      "signed": "none",      "bytes": 1,      "sha256": "string",      "arch": "x64"    }  },  "expiresAt": "string",  "shownOnce": "string",  "enrol": {    "windows": "string",    "macos": "string",    "linux": "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.