v1

latestOpenAPI 3.1.02026-07-261690320.7 KB

Generate bulk SBOM

Returns an SBOM of all packages & licenses found in specified containers

post/containers/sbom/generate

Request body

format'csv' | 'sbom' | 'sbom_spdx'

The format of the sbom

include_risk_reasoninteger

Flag to include risk reason in CSV export. 1 or 0 indicating true or false

Example request

{
  "format": "sbom",
  "containers": [
    {
      "name": "nginx"
    },
    {
      "name": "node",
      "tag": "14"
    }
  ]
}

Response

An SBOM of all packages & licenses found in specified containers

{"stackTrail":"paths:/containers/sbom/generate:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown","title":"SBOM","description":"A CycloneDX or SPDX SBOM JSON","example":{"bomFormat":"CycloneDX","specVersion":"1.4","version":1,"metadata":{"timestamp":"1998-07-04T16:20:00.069Z"},"components":[{"type":"library","group":"","name":"ghc-ShellCheck","version":"0.3.5-1.el7","licenses":[{"expression":"AGPLv3+"}],"purl":""}]}}

Example response

{
  "bomFormat": "CycloneDX",
  "specVersion": "1.4",
  "version": 1,
  "metadata": {
    "timestamp": "1998-07-04T16:20:00.069Z"
  },
  "components": [
    {
      "type": "library",
      "group": "",
      "name": "ghc-ShellCheck",
      "version": "0.3.5-1.el7",
      "licenses": [
        {
          "expression": "AGPLv3+"
        }
      ],
      "purl": ""
    }
  ]
}