Skip to content

Whether a release may ship, read from every promised journey's error budget

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

A token that can read is enough.

Done.

Media typeapplication/json
object
at
required
string
policy
required
string
next
required
string
allow
required
boolean
verdict
required
string
Allowed values: freeze go hold
change
required
string
Allowed values: security fix feature
why
required
string
readings
required
Array<object>
object
journeyId
required
string
name
required
string
objective
required
number
good
required
number
total
required
number
allowedBad
required
number
bad
required
number
spent
required
One of:
number
burning
required
Array<string>
verdict
required
string
Allowed values: freeze go hold
why
required
string

Example

{  "at": "string",  "policy": "string",  "next": "string",  "allow": true,  "verdict": "freeze",  "change": "security",  "why": "string",  "readings": [    {      "journeyId": "string",      "name": "string",      "objective": 1,      "good": 1,      "total": 1,      "allowedBad": 1,      "bad": 1,      "spent": 1,      "burning": [        "string"      ],      "verdict": "freeze",      "why": "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.