Sign in
sbom

Get SBOM for an environment

Get SBOM (Software Bill of Materials) for an environment.

Args: body: Request body containing lockfile and environment metadata format: SBOM format (defaults to SbomFormat.SPDX_2_3_JSON) user: Authenticated user context cache: Request-scoped dependency cache (injected)

Returns: SBOM document in the requested format

Raises: HTTPException: If lockfile is malformed, system is invalid, or SBOM generation fails

post/api/v1/catalog/sbom/environment

Query parameters

format'spdx-2.3-json'

Supported SBOM format types.

Request body

lockfileobject required
system'aarch64-darwin' | 'aarch64-linux' | 'x86_64-darwin' | 'x86_64-linux' | 'invalid' required
environment_namestring required
environment_ownerstring required
generationinteger nullable

Response

SBOM for the given environment

object required

Changes

Changed in 2 of the 53 revisions of this API.11