Read a container image's bill of materials from its own registry, or download it as CycloneDX or SPDX
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.
const url = 'https://api.xovris.ai/v1/reviews/image-bill';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://api.xovris.ai/v1/reviews/image-bill \ --header 'Authorization: Bearer <token>'A token that can read is enough.
Authorizations
Section titled “Authorizations”Responses
Section titled “Responses”Done.
object
object
object
object
object
object
object
object
object
object
Example
{ "image": "string", "digest": "string", "platform": "string", "os": "string", "layers": 1, "counts": { "packages": 1, "development": 1, "withLicence": 1, "advisories": 1, "served": 1, "notBuilt": 1, "triage": 1, "risk": { "unknown": 1, "restricted": 1, "reciprocal": 1, "notice": 1, "permissive": 1, "unencumbered": 1, "by_exception_only": 1, "forbidden": 1 } }, "packages": [ { "purl": "string", "ecosystem": "string", "name": "string", "version": "string", "development": true, "licence": "string", "risk": "unknown", "lockfiles": [ "string" ], "direct": true, "path": [ "string" ], "advisories": 1, "range": "string" } ], "unread": [ "string" ], "policy": { "unknown": "block", "restricted": "block", "reciprocal": "block", "notice": "block", "permissive": "block", "unencumbered": "block", "by_exception_only": "block", "forbidden": "block", "internal": [ "string" ] }, "obligations": {}}Not signed in: the token is missing, expired or revoked. The answer says how to get a new one.
object
object
A stable code a program can branch on.
What happened, in plain words.
What to do next.
The recorded authorisation decision, when a role refused it.
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.
object
object
A stable code a program can branch on.
What happened, in plain words.
What to do next.
The recorded authorisation decision, when a role refused it.
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.
object
object
A stable code a program can branch on.
What happened, in plain words.
What to do next.
The recorded authorisation decision, when a role refused it.
Example generated
{ "error": { "code": "example", "message": "example", "nextStep": "example", "decisionId": "example" }}default
Section titled “default”Any other refusal or failure. The answer says what happened and what to do next.
object
object
A stable code a program can branch on.
What happened, in plain words.
What to do next.
The recorded authorisation decision, when a role refused it.
Example generated
{ "error": { "code": "example", "message": "example", "nextStep": "example", "decisionId": "example" }}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.