Skip to content

Add a log archive destination

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.

POST
/v1/log-archive/destinations
curl --request POST \  --url https://api.xovris.ai/v1/log-archive/destinations \  --header 'Authorization: Bearer <token>' \  --header 'Content-Type: application/json' \  --data '{ "provider": null, "endpoint": "string", "location": null, "credentials": { "accessKeyId": null, "secretAccessKey": null, "sessionToken": null }, "region": "string", "account": "string", "tiers": null, "prefix": null, "format": null }'

Needs a token that can read and change. A token without change access is refused with token_read_only and the step to take.

Media typeapplication/json
object
provider
endpoint
string
location
credentials
object
accessKeyId
secretAccessKey
sessionToken
region
string
account
string
tiers
prefix
format

Example

{  "provider": null,  "endpoint": "string",  "location": null,  "credentials": {    "accessKeyId": null,    "secretAccessKey": null,    "sessionToken": null  },  "region": "string",  "account": "string",  "tiers": null,  "prefix": null,  "format": null}

Done: something new was made, and the answer is it.

Media typeapplication/json
object
id
required
string
provider
required
string
Allowed values: gcs s3 r2 azure webdav
location
required
string
region
One of:
string
regionFound
required
One of:
string
prefix
required
string
format
required
string
Allowed values: otlp-json parquet
tiers
required
object
hotDays
required
number
warmAfterDays
required
One of:
number
coldAfterDays
required
One of:
number
deleteAfterDays
required
One of:
number
azureArchive
boolean
lifecycle
required
string
lifecycleApplied
required
One of:
object
applied
required
boolean
reason
required
string
next
required
string
kept
undo
retry
next
required
string

Example

{  "id": "string",  "provider": "gcs",  "location": "string",  "region": "string",  "regionFound": "string",  "prefix": "string",  "format": "otlp-json",  "tiers": {    "hotDays": 1,    "warmAfterDays": 1,    "coldAfterDays": 1,    "deleteAfterDays": 1,    "azureArchive": true  },  "lifecycle": "string",  "lifecycleApplied": {    "applied": true,    "reason": "string",    "next": "string",    "kept": null,    "undo": null,    "retry": null  },  "next": "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.