Skip to content

See the credit a provider owes you for its downtime, in your own currency

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/sla/credit
curl --request POST \  --url https://api.xovris.ai/v1/sla/credit \  --header 'Authorization: Bearer <token>' \  --header 'Content-Type: application/json' \  --data '{ "currency": null, "provider": null, "service": null, "month": null, "downMinutes": null, "monthlyFeeMinor": 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
currency
provider
service
month
downMinutes
monthlyFeeMinor

Example

{  "currency": null,  "provider": null,  "service": null,  "month": null,  "downMinutes": null,  "monthlyFeeMinor": null}

Done.

Media typeapplication/json
object
uptime
required
number
owed
required
boolean
creditPct
required
number
creditDays
required
One of:
number
creditMinor
required
number
currency
required
string
claimBy
required
One of:
string
claim
required
One of:
string
source
required
One of:
string
whatXovrisDoes
required
string

Example

{  "uptime": 1,  "owed": true,  "creditPct": 1,  "creditDays": 1,  "creditMinor": 1,  "currency": "string",  "claimBy": "string",  "claim": "string",  "source": "string",  "whatXovrisDoes": "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.