Generate bulk SBOM

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

post/containers/sbom/generate

Request

Base URL
https://app.aikido.dev/api/public/v1
URL
https://app.aikido.dev/api/public/v1/containers/sbom/generate
Auth
OAuth 2
Client credentials
Token URL: https://app.aikido.io/api/oauth/token scopes: repositories:write

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

unknown required

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": ""
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.