View as Markdown

llms.txt

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:57 UTC.

API reference Models

SbomManifestDto

A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.

Expanded view of one SBOM build: the build summary plus every CycloneDX component document available for download.

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
build required SbomBuildDto SbomBuildDto Summary record for a single archived SBOM build. A build corresponds to one CI pipeline run that produced CycloneDX documents for each deployable component (for example the web application or a background worker).
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 of SbomBuildDto:

Field Type Description
buildId required string CI build id (e.g. Azure Pipelines `$(Build.BuildId)`). 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.
createdUtc required string (date-time) UTC timestamp recorded by the CI pipeline when the build was produced.
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.
commitSha required string Git commit SHA that produced the build. 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.
branch required string Branch the build was produced from (e.g. `refs/heads/develop`). 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.
environment required string Environment label associated with the build (`dev`, `staging`, `production`). 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.
componentCount required integer (int32) Number of CycloneDX component documents archived for this build.
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 body has no documented fields.

components required array of SbomComponentDto array of SbomComponentDto 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.

Fields of each SbomComponentDto:

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 body has no documented fields.

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.