AIaikido

Export SBOM

Returns an overview of all packages & licenses found in a container

get/containers/{container_repo_id}/licenses/export

Request

  • Base URL
    https://app.aikido.dev/api/public/v1
  • URL
    https://app.aikido.dev/api/public/v1/containers/{container_repo_id}/licenses/export
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://app.aikido.io/api/oauth/token scopes: repositories:read

Path parameters

container_repo_idinteger required

The ID of the container repo

Query parameters

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

The format of the export

include_risk_reasoninteger

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

include_vexinteger

Flag to include VEX analysis in CycloneDX SBOM. 1 or 0 indicating true or false

Response

An overview of all licenses and packages found in a container

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.