Skip to content

Compare your log agents' settings with Xovris's

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

A token that can read is enough.

Done.

Media typeapplication/json
object
window
required
object
since
required
string
until
required
string
received
required
Array<object>
object
forwarder
required
string
sourceId
required
string
name
required
string
received
required
number
stored
required
number
failed
required
number
dropped
required
number
firstSeen
required
One of:
string
lastSeen
required
One of:
string
gaps
required
Array<object>
object
sourceId
required
string
from
required
string
to
required
string
minutes
required
number
lines
required
Array<object>
object
kind
required
string
Allowed values: later earlier only_xovris only_old_tool
minutes
required
One of:
number
sentence
required
string
records
required
object
incidentId
string
alertRecordId
string
summary
required
string

Example

{  "window": {    "since": "string",    "until": "string"  },  "received": [    {      "forwarder": "string",      "sourceId": "string",      "name": "string",      "received": 1,      "stored": 1,      "failed": 1,      "dropped": 1,      "firstSeen": "string",      "lastSeen": "string"    }  ],  "gaps": [    {      "sourceId": "string",      "from": "string",      "to": "string",      "minutes": 1    }  ],  "lines": [    {      "kind": "later",      "minutes": 1,      "sentence": "string",      "records": {        "incidentId": "string",        "alertRecordId": "string"      }    }  ],  "summary": "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.