WinkPG Docs
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-11-12 05:58 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 one build in the SBOM evidence store. A build is one release: a version and commit of the instance's own distribution, with one CycloneDX document per 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 Opaque key for the build. Take it from the build list and pass it back to read the build or download one of its documents; do not compose it. 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 time the pipeline filed the build's first document in the evidence store.
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. Always null: a build is not built for an environment, and which environment runs which build is recorded at deploy time. 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 deployable components with a CycloneDX document in 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.
distribution required string The distribution the build belongs to: `core`, or `fork-{slug}` for a build of a licensed source fork. 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.
version required string The build number the release pipeline assigned. 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.
pipelineRunId required string The pipeline run 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.
isRunningBuild required boolean True when this is the build this instance is running, confirmed by the digest it was deployed from; false when the running build is identified and this is a different one; null when the running build is not identified, so no build can be called the running one. 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 body has no documented fields.

components required array of SbomComponentDto array of SbomComponentDto One entry per deployable, ordered by name. 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 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.
description required 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.
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.
digest required 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.
digestKind required 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.
matchesThisInstance required 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 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.