Skip to content

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.

GET
/v1/reviews/image-bill
curl --request GET \  --url https://api.xovris.ai/v1/reviews/image-bill \  --header 'Authorization: Bearer <token>'

A token that can read is enough.

Done.

Media typeapplication/json
object
image
required
string
digest
required
One of:
string
platform
required
string
os
required
One of:
string
layers
required
number
counts
required
object
packages
required
number
development
required
number
withLicence
required
number
advisories
required
number
served
required
number
notBuilt
required
number
triage
required
number
risk
required
object
unknown
required
number
restricted
required
number
reciprocal
required
number
notice
required
number
permissive
required
number
unencumbered
required
number
by_exception_only
required
number
forbidden
required
number
packages
required
Array<object>
object
purl
required
string
ecosystem
required
string
name
required
string
version
required
string
development
required
boolean
licence
required
One of:
string
risk
required
string
Allowed values: unknown restricted reciprocal notice permissive unencumbered by_exception_only forbidden
lockfiles
required
Array<string>
direct
required
boolean
path
required
Array<string>
advisories
required
number
range
required
One of:
string
unread
required
Array<string>
policy
object
unknown
required
string
Allowed values: block review allow
restricted
required
string
Allowed values: block review allow
reciprocal
required
string
Allowed values: block review allow
notice
required
string
Allowed values: block review allow
permissive
required
string
Allowed values: block review allow
unencumbered
required
string
Allowed values: block review allow
by_exception_only
required
string
Allowed values: block review allow
forbidden
required
string
Allowed values: block review allow
internal
Array<string>
obligations
object
key
additional properties
object
titles
required
Array<string>
choice
required
boolean
asks
required
Array<object>
object
label
required
string
description
required
string
lets
required
Array<object>
object
label
required
string
description
required
string
leaves
required
Array<object>
object
label
required
string
description
required
string

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.

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.