Skip to content

Search archived logs

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

A token that can read is enough.

Done.

Media typeapplication/json
One of:
object
understood
required
string
window
required
object
since
required
string
until
required
string
results
required
Array<object>
object
records
required
Array<object>
object
tenantId
required
string
id
required
string
timestamp
required
string
sourceTimestamp
required
One of:
string
observedAt
required
string
severityNumber
required
number
severityText
required
string
raisedFrom
required
number
body
required
string
templateId
required
string
template
required
string
source
required
object
kind
required
string
Allowed values: email check change otlp envelope agent syslog webhook audit access pasted
id
required
string
name
required
string
service
required
One of:
string
host
required
One of:
string
assetRef
required
One of:
string
traceId
required
One of:
string
spanId
required
One of:
string
incidentId
required
One of:
string
changeRunId
required
One of:
string
attributes
required
object
key
additional properties
string
observedByXovris
required
boolean
masked
required
number
masks
object
key
additional properties
number
retentionDays
required
number
fullRetentionDays
number
total
required
number
bySeverity
required
object
fatal
required
number
error
required
number
warn
required
number
info
required
number
debug
required
number
first
required
One of:
string
last
required
One of:
string
destination
required
string
keptBy
required
string
next
required
string
connect
required
object
method
required
string
path
required
string
body
required
object
endpoint
required
string
credentials
required
object
<the store's key fields>
required
string

Example

{  "understood": "string",  "window": {    "since": "string",    "until": "string"  },  "results": [    {      "records": [        {          "tenantId": "string",          "id": "string",          "timestamp": "string",          "sourceTimestamp": "string",          "observedAt": "string",          "severityNumber": 1,          "severityText": "string",          "raisedFrom": 1,          "body": "string",          "templateId": "string",          "template": "string",          "source": {            "kind": "email",            "id": "string",            "name": "string"          },          "service": "string",          "host": "string",          "assetRef": "string",          "traceId": "string",          "spanId": "string",          "incidentId": "string",          "changeRunId": "string",          "attributes": {},          "observedByXovris": true,          "masked": 1,          "masks": {},          "retentionDays": 1,          "fullRetentionDays": 1        }      ],      "total": 1,      "bySeverity": {        "fatal": 1,        "error": 1,        "warn": 1,        "info": 1,        "debug": 1      },      "first": "string",      "last": "string",      "destination": "string",      "keptBy": "string"    }  ],  "next": "string",  "connect": {    "method": "string",    "path": "string",    "body": {      "endpoint": "string",      "credentials": {        "<the store's key fields>": "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.