Skip to content

Have Xovris read each bucket's own inventory report and plan every saving it finds, changing nothing

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/storage/waste/read
curl --request POST \  --url https://api.xovris.ai/v1/storage/waste/read \  --header 'Authorization: Bearer <token>' \  --header 'Content-Type: application/json' \  --data '{ "bucket": "string", "inventoryId": "string", "connectionId": "string", "coldAfterDays": 1 }'

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
bucket
string
inventoryId
string
connectionId
string
coldAfterDays
number

Example

{  "bucket": "string",  "inventoryId": "string",  "connectionId": "string",  "coldAfterDays": 1}

Done.

Media typeapplication/json
One of:
object
id
required
string
role_arn
required
string
region
required
string
account_id
required
string

Example

{  "id": "string",  "role_arn": "string",  "region": "string",  "account_id": "string"}

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

Media typeapplication/json
One of:
object
next
required
string
read
object
key
additional properties
id
required
string
bucket
required
string
findings
required
Array<object>
object
class
required
string
Allowed values: noncurrent_unexpired small_in_min_class duplicates cold_in_hot no_abort_multipart
objects
required
number
bytes
required
number
monthlyCents
required
One of:
number
sentence
required
string
plan
required
object
tagForCold
required
Array<string>
coldRule
required
One of:
object
ID
string
Status
string
Filter
Transitions
Array
NoncurrentVersionExpiration
AbortIncompleteMultipartUpload
deleteCopies
required
Array<object>
object
key
required
string
keep
required
string
bytes
required
number
extraRules
required
Array<object>
object
ID
string
Status
string
Filter
Transitions
Array
NoncurrentVersionExpiration
AbortIncompleteMultipartUpload
keptBecauseRead
required
number
sentence
required
string
monthlyListPriceUsd
required
string
accessLogs
required
One of:
object
lines
required
number
unreadable
required
number
from
required
One of:
string
to
required
One of:
string
verifyAfter
required
string

Example

{  "next": "string",  "read": {},  "id": "string",  "bucket": "string",  "findings": [    {      "class": "noncurrent_unexpired",      "objects": 1,      "bytes": 1,      "monthlyCents": 1,      "sentence": "string"    }  ],  "plan": {    "tagForCold": [      "string"    ],    "coldRule": {      "ID": "string",      "Status": "string",      "Filter": null,      "Transitions": [        null      ],      "NoncurrentVersionExpiration": null,      "AbortIncompleteMultipartUpload": null    },    "deleteCopies": [      {        "key": "string",        "keep": "string",        "bytes": 1      }    ],    "extraRules": [      {        "ID": "string",        "Status": "string",        "Filter": null,        "Transitions": [          null        ],        "NoncurrentVersionExpiration": null,        "AbortIncompleteMultipartUpload": null      }    ],    "keptBecauseRead": 1,    "sentence": "string"  },  "monthlyListPriceUsd": "string",  "accessLogs": {    "lines": 1,    "unreadable": 1,    "from": "string",    "to": "string"  },  "verifyAfter": "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.