Skip to content

Read how long logs are kept

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

A token that can read is enough.

Done.

Media typeapplication/json
object
plan
required
object
says
string
linesPerMonth
required
number
searchableDays
required
number
retainedDays
required
number
confirmed
required
boolean
id
required
string
Allowed values: free personal personal_protect business business_protect scale enterprise builder
month
required
object
stored
required
number
dropped
required
number
allowance
required
number
keptForDays
required
number
presets
required
Array<object>
object
on
required
boolean
preset
required
object
id
required
string
Allowed values: pci-dss-10.5.1 hipaa-164.316 microsoft-365-audit google-workspace-audit uk-gdpr-minimum
name
required
string
searchableDays
required
number
retainedDays
required
number
source
required
string
covered
required
boolean
sentence
required
string
dryRun
required
One of:
object
key
additional properties

Example

{  "plan": {    "says": "string",    "linesPerMonth": 1,    "searchableDays": 1,    "retainedDays": 1,    "confirmed": true,    "id": "free"  },  "month": {    "stored": 1,    "dropped": 1,    "allowance": 1  },  "keptForDays": 1,  "presets": [    {      "on": true,      "preset": {        "id": "pci-dss-10.5.1",        "name": "string",        "searchableDays": 1,        "retainedDays": 1,        "source": "string"      },      "covered": true,      "sentence": "string"    }  ],  "dryRun": {}}

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.