Skip to content

Read which log lines are kept and dropped

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

A token that can read is enough.

Done.

Media typeapplication/json
object
on
required
boolean
applied
required
One of:
object
version
required
number
words
required
string
proof
required
appliedAt
required
string
yourRulesWin
required
boolean
proposal
required
object
words
required
string
rules
required
Array<object>
object
id
required
string
action
required
string
Allowed values: keep route sample drop mask
match
required
object
severityAtLeast
One of:
number
severityBelow
One of:
number
services
Array<string>
sourceKinds
Array<string>
contains
Array<string>
preset
One of:
string
Allowed values: health_checks security_events access_logs audit_trail
not
boolean
rate
number
destination
string
alsoKeep
boolean
mask
string
Allowed values: tokens emails card_numbers ip_addresses phone_numbers
words
required
string
lines
required
number
kept
required
number
removed
required
number
replayed
required
number
wouldLoseEvidence
required
Array<object>
object
incidentId
required
string
lineId
required
string
words
required
string
sentence
required
string

Example

{  "on": true,  "applied": {    "version": 1,    "words": "string",    "proof": null,    "appliedAt": "string"  },  "yourRulesWin": true,  "proposal": {    "words": "string",    "rules": [      {        "id": "string",        "action": "keep",        "match": {          "severityAtLeast": 1,          "severityBelow": 1,          "services": [            "string"          ],          "sourceKinds": [            "string"          ],          "contains": [            "string"          ],          "preset": "health_checks",          "not": true        },        "rate": 1,        "destination": "string",        "alsoKeep": true,        "mask": "tokens",        "words": "string"      }    ],    "lines": 1,    "kept": 1,    "removed": 1,    "replayed": 1,    "wouldLoseEvidence": [      {        "incidentId": "string",        "lineId": "string",        "words": "string"      }    ],    "sentence": "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.