Skip to content

Explain an error or log line

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/logs/explain
curl --request POST \  --url https://api.xovris.ai/v1/logs/explain \  --header 'Authorization: Bearer <token>' \  --header 'Content-Type: application/json' \  --data '{ "text": "string", "keep": null, "idempotencyKey": "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
text
string
keep
idempotencyKey
string

Example

{  "text": "string",  "keep": null,  "idempotencyKey": "string"}

Done.

Media typeapplication/json
One of:
One of:
object
stored
required
boolean
recognised
required
boolean
id
required
string
system
required
string
title
required
string
meaning
required
string
causes
required
Array<string>
next
required
Array<string>
doors
required
Array
One of:
object
kind
required
string
Allowed values: diag.network diag.system fix.step fix.dns.flush logs.recent repo.fix zone.record cert.renew watch.on mail.repair
input
required
object
key
additional properties
does
required
string
change
required
boolean
via
string
Allowed values: zone device xovris repository certificate
first
source
required
object
title
required
string
url
required
string
severity
required
string
Allowed values: error warning fatal
line
required
string
facts
required
object
key
additional properties
string
alsoSeen
required
Array<object>
object
id
required
string
system
required
string
title
required
string
line
required
string
masked
required
number

Example

{  "stored": true,  "recognised": true,  "id": "string",  "system": "string",  "title": "string",  "meaning": "string",  "causes": [    "string"  ],  "next": [    "string"  ],  "doors": [    {      "kind": "diag.network",      "input": {},      "does": "string",      "change": true,      "via": "zone",      "first": null    }  ],  "source": {    "title": "string",    "url": "string"  },  "severity": "error",  "line": "string",  "facts": {},  "alsoSeen": [    {      "id": "string",      "system": "string",      "title": "string",      "line": "string"    }  ],  "masked": 1}

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.