AIaikido

Export SBOM

Returns a SBOM of a virtual machine

get/virtual-machines/{virtual_machine_id}/export/{format}

Request

  • Base URL
    https://app.aikido.dev/api/public/v1
  • URL
    https://app.aikido.dev/api/public/v1/virtual-machines/{virtual_machine_id}/export/{format}
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://app.aikido.io/api/oauth/token scopes: virtual_machines:read

Path parameters

virtual_machine_idinteger required

The id of the virtual machine

formatstring required

The desired format of the virtual machine export. Can be 'sbom', 'sbom_spdx' or 'csv'

Response

the sbom a virtual machine

unknown required

Example response

{
  "bomFormat": "CycloneDX",
  "specVersion": "1.4",
  "version": 1,
  "metadata": {
    "timestamp": "2025-02-04T12:07:38.483Z"
  },
  "components": [
    {
      "type": "library",
      "group": "",
      "name": "8021q",
      "version": "1.8",
      "licenses": [
        {
          "expression": "GPL"
        }
      ],
      "purl": "pkg:generic/8021q@1.8"
    }
  ]
}

Changes

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