Skip to main content
GET
The fleet's software bill of materials

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page
integer
default:1
Required range: 1 <= x <= 10000
page_size
integer
default:50

Values above 100 are clamped to 100.

Required range: x >= 1
package_type
string[]

Ecosystem filter, repeatable (deb, apk, rpm, npm, pypi, golang, maven, ...).

cluster_id
string<uuid>
namespace
string
image
string

Only components inside one image (digest or repository:tag identity).

vulnerable
boolean

true keeps components a finding names, false the ones nothing names.

sort
enum<string>
default:images
Available options:
name,
version,
package_type,
images,
workloads,
clusters,
vulnerable,
actionable
order
enum<string>
default:desc
Available options:
asc,
desc

Response

Successful response

result
SecuritySbomComponentSummary · object[]
required
pagination
object
required
facets
SecuritySbomComponentFacets · object
required
coverage
SecuritySbomCoverage · object
required