Skip to content

List log sources

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

A token that can read is enough.

Done.

Media typeapplication/json
object
items
required
Array<object>
object
kind
required
string
id
required
string
name
required
string
health
required
One of:
object
state
required
string
Allowed values: receiving
lastSeenAt
required
string
firstSeenAt
required
One of:
string
historyStartsAt
required
One of:
string
lastDay
required
One of:
object
received
required
number
stored
required
number
failed
required
number
dropped
required
number
masked
required
number
missing
required
number
balanced
required
One of:
boolean
gaps
required
Array<object>
object
from
required
string
to
required
string
incidentId
required
One of:
string
parser
required
One of:
object
reads
required
string
learnedAt
required
string
learnedFrom
required
number
tested
required
object
heldBack
required
number
read
required
number
failures
required
Array<object>
object
kind
required
string
sourceId
required
string
at
required
string
reason
required
string
sample
required
string

Example

{  "items": [    {      "kind": "string",      "id": "string",      "name": "string",      "health": {        "state": "receiving",        "lastSeenAt": "string"      },      "firstSeenAt": "string",      "historyStartsAt": "string",      "lastDay": {        "received": 1,        "stored": 1,        "failed": 1,        "dropped": 1,        "masked": 1,        "missing": 1      },      "balanced": true,      "gaps": [        {          "from": "string",          "to": "string",          "incidentId": "string"        }      ],      "parser": {        "reads": "string",        "learnedAt": "string",        "learnedFrom": 1,        "tested": {          "heldBack": 1,          "read": 1        }      }    }  ],  "failures": [    {      "kind": "string",      "sourceId": "string",      "at": "string",      "reason": "string",      "sample": "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.