v1

latestOpenAPI 3.1.02026-07-261690320.7 KB

Export SBOM

Returns a SBOM of a virtual machine

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

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

{"stackTrail":"paths:/virtual-machines/{virtual_machine_id}/export/{format}:get:responses:200:content:application/json:schema","oasType":"schema","type":"unknown","title":"Virtual machine SBOM Export","example":{"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"}]}}

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