The API reference isn't available right now
This instance couldn't load its API specification. The reference returns as soon as the specification is readable again.
Back to the API reference
No such model
This instance publishes no model under that name. It may have been renamed, or no operation this installation serves uses it.
Back to the API reference
This reference may be out of date
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-10-22 22:52 UTC.
API reference
/
Models
SbomComponentDtoA 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 name
required string
Component identifier used in the blob path (e.g. `blazor`, `functions`, `dbmigrator`).
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.
description
required string
Human-readable description populated by the CI step.
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.
specVersion
required 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.
sizeBytes
required 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.
This model has no documented fields.
Next steps