Skip to content

Download a fix's signed proof - the cause, the tests before and after and their verdicts

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/incidents/{id}/runs/{runId}/proof
curl --request GET \  --url https://api.xovris.ai/v1/incidents/example/runs/example/proof \  --header 'Authorization: Bearer <token>'

A token that can read is enough.

id
required
string
runId
required
string

Done.

Media typeapplication/json
object
proven
required
boolean
stillOwed
required
Array<string>
publicKey
required
string
envelope
required
object
payloadType
required
string
Allowed values: application/vnd.in-toto+json
payload
required
string
signatures
required
Array<object>
object
keyid
required
string
sig
required
string
statement
required
object
_type
required
string
Allowed values: https://in-toto.io/Statement/v1
subject
required
Array<object>
object
name
required
string
digest
required
object
sha256
required
string
predicateType
required
string
Allowed values: https://xovris.ai/attestations/fix-proof/v1
predicate
required
object
workspace
required
string
incident
required
string
run
required
string
state
required
string
action
required
object
id
required
string
version
required
number
entryDigest
required
string
inputSha256
required
string
cause
required
One of:
object
status
required
string
sha256
required
string
before
required
One of:
object
passed
required
boolean
sha256
required
string
after
required
One of:
object
passed
required
boolean
sha256
required
string
verdicts
required
Array<object>
object
kind
required
string
passed
required
boolean
sha256
required
string

Example

{  "proven": true,  "stillOwed": [    "string"  ],  "publicKey": "string",  "envelope": {    "payloadType": "application/vnd.in-toto+json",    "payload": "string",    "signatures": [      {        "keyid": "string",        "sig": "string"      }    ]  },  "statement": {    "_type": "https://in-toto.io/Statement/v1",    "subject": [      {        "name": "string",        "digest": {          "sha256": "string"        }      }    ],    "predicateType": "https://xovris.ai/attestations/fix-proof/v1",    "predicate": {      "workspace": "string",      "incident": "string",      "run": "string",      "state": "string",      "action": {        "id": "string",        "version": 1,        "entryDigest": "string",        "inputSha256": "string"      },      "cause": {        "status": "string",        "sha256": "string"      },      "before": {        "passed": true,        "sha256": "string"      },      "after": {        "passed": true,        "sha256": "string"      },      "verdicts": [        {          "kind": "string",          "passed": true,          "sha256": "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.