Skip to content

List the log agents you can point at Xovris

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

A token that can read is enough.

Done.

Media typeapplication/json
object
items
required
Array<object>
object
forwarder
required
string
Allowed values: elastic_beats logstash datadog splunk_hec loki vector fluent_bit newrelic
name
required
string
setup
required
One of:
object
setting
required
string
value
required
string
key
required
string
dualShip
required
string
door
object
kind
required
string
Allowed values: fix.step
input
required
object
op
required
string
route
required
object
method
required
string
path
required
string
body
required
object
logs
required
boolean
does
required
string
change
required
boolean
setupProblem
required
One of:
string
receiving
required
boolean
lastDay
required
One of:
object
received
required
number
stored
required
number
failed
required
number
dropped
required
number
lastSeenAt
required
One of:
string
services
required
Array<string>
looksLike
required
One of:
object
format
required
string
share
required
number
says
required
string
sampleProblem
required
null

Example

{  "items": [    {      "forwarder": "elastic_beats",      "name": "string",      "setup": {        "setting": "string",        "value": "string",        "key": "string",        "dualShip": "string",        "door": {          "kind": "fix.step",          "input": {            "op": "string"          },          "route": {            "method": "string",            "path": "string",            "body": {              "logs": true            }          },          "does": "string",          "change": true        }      },      "setupProblem": "string",      "receiving": true,      "lastDay": {        "received": 1,        "stored": 1,        "failed": 1,        "dropped": 1      },      "lastSeenAt": "string",      "services": [        "string"      ],      "looksLike": {        "format": "string",        "share": 1,        "says": "string"      },      "sampleProblem": null    }  ]}

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.