Interface downloadSbomOptionsParams

interface downloadSbomOptionsParams {
    assetVersionId: string;
    outputFilename?: string;
    sbomSubtype?: "SBOM_ONLY" | "SBOM_WITH_VDR" | "VDR_ONLY";
    sbomType?: "CYCLONEDX" | "SPDX";
    verbose?: boolean;
}

Properties

assetVersionId outputFilename? sbomSubtype? sbomType? verbose?

Properties

assetVersionId

assetVersionId: string

The Asset Version ID to download the SBOM for.

OptionaloutputFilename

outputFilename?: string

The local filename to save the SBOM to. If not provided, the SBOM will be saved to a file named "sbom.json" in the current directory.

OptionalsbomSubtype

sbomSubtype?: "SBOM_ONLY" | "SBOM_WITH_VDR" | "VDR_ONLY"

The subtype of SBOM to download. Valid values for CycloneDX are "SBOM_ONLY", "SBOM_WITH_VDR", "VDR_ONLY. For SPDX valid values are "SBOM_ONLY". Defaults to "SBOM_ONLY".

OptionalsbomType

sbomType?: "CYCLONEDX" | "SPDX"

The type of SBOM to download. Valid values are "CYCLONEDX" and "SPDX". Defaults to "CYCLONEDX".

Optionalverbose

verbose?: boolean

If True, will print additional information to the console. Defaults to False.

Settings

Member Visibility

On This Page

Properties