Skip to content

Add a private probe

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/checks/probes
curl --request POST \  --url https://api.xovris.ai/v1/checks/probes \  --header 'Authorization: Bearer <token>' \  --header 'Content-Type: application/json' \  --data '{ "place": null, "deviceId": null, "self": null }'

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
place
deviceId
self

Example

{  "place": null,  "deviceId": null,  "self": null}

Done.

Media typeapplication/json
One of:
object
ok
required
boolean
choose
required
Array<object>
object
deviceId
required
string
name
required
string
lastSeenAt
required
One of:
string
start
required
object
label
required
string
method
required
string
path
required
string
body
required
object
place
required
string
deviceId
required
string
next
required
string
manual
required
object
label
required
string
method
required
string
path
required
string
body
required
object
place
required
string
self
required
boolean

Example

{  "ok": true,  "choose": [    {      "deviceId": "string",      "name": "string",      "lastSeenAt": "string",      "start": {        "label": "string",        "method": "string",        "path": "string",        "body": {          "place": "string",          "deviceId": "string"        }      }    }  ],  "next": "string",  "manual": {    "label": "string",    "method": "string",    "path": "string",    "body": {      "place": "string",      "self": true    }  }}

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

Media typeapplication/json
object
ok
required
boolean
location
required
object
id
required
string
provider
required
string
Allowed values: gcp aws private local
region
required
string
place
required
string
private
required
boolean
token
required
string
runCommand
required
string
fix
required
object
label
required
string
method
required
string
path
required
string
next
required
string

Example

{  "ok": true,  "location": {    "id": "string",    "provider": "gcp",    "region": "string",    "place": "string",    "private": true  },  "token": "string",  "runCommand": "string",  "fix": {    "label": "string",    "method": "string",    "path": "string"  },  "next": "string"}

Started: the answer says where to follow it.

Media typeapplication/json
object
ok
required
boolean
location
required
object
id
required
string
provider
required
string
Allowed values: gcp aws private local
region
required
string
place
required
string
private
required
boolean
startedOn
required
object
deviceId
required
string
name
required
string
checkId
required
string
next
required
string
manual
required
object
label
required
string
method
required
string
path
required
string
body
required
object
place
required
string
self
required
boolean
undo
required
object
label
required
string
method
required
string
path
required
string

Example

{  "ok": true,  "location": {    "id": "string",    "provider": "gcp",    "region": "string",    "place": "string",    "private": true  },  "startedOn": {    "deviceId": "string",    "name": "string"  },  "checkId": "string",  "next": "string",  "manual": {    "label": "string",    "method": "string",    "path": "string",    "body": {      "place": "string",      "self": true    }  },  "undo": {    "label": "string",    "method": "string",    "path": "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.