This instance couldn't reach its API specification on the last attempt, so this page shows the copy fetched before that. Anything added or changed since then is missing here, and the reference updates itself as soon as the specification is readable again. Last fetched 2026-11-12 05:58 UTC.
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
One CycloneDX document within an SBOM build, covering one deployable component (for example
the web application or a background worker).
Values
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Fields
Field
Type
Description
namerequired
string
The deployable's service name (e.g. `blazor`, `trxmanager`, `dbmigrator`), used as
the component name in the download path. Filename of the download is `{Name}.cdx.json`.nullable
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
descriptionrequired
string
Human-readable description. Always null: the SBOM evidence store records none.nullable
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
specVersionrequired
string
CycloneDX specification version used to generate this document.nullable
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
sizeBytesrequired
integer (int64)
Size of the CycloneDX JSON document in bytes.
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
digestrequired
string
`sha256:{hex}` digest of the image or artifact the document describes.nullable
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
digestKindrequired
string
`image` for a container image digest, `artifact` for the sha256 of a deployed file.nullable
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
matchesThisInstancerequired
boolean
True when this is this instance's own deployable and the document's digest is the digest the
instance was deployed from; null for every other deployable, whose deployed digest this
instance does not know.nullable
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
This model has no documented fields.
Reconnecting to the server
Could not reconnect
This session has ended
Attempt 1
Your work on this page is still here. Retrying keeps it; reloading starts the page again.
The server no longer holds this page's state, so it has to be loaded again.