v1

latestOpenAPI 3.1.02026-07-261690320.7 KB

Export SBOM

Returns an overview of all packages & licenses found in a code repository

get/repositories/code/{code_repo_id}/licenses/export

Path parameters

code_repo_idinteger required

The ID of the code repo

Query parameters

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

The format of the export

locationstring

The path to filter on

Filter all locations by path ending with this value. For example client/package-lock.json

language'dotnet' | 'java' | 'js' | 'go' | 'rust' | 'dart' | 'swift' | 'ruby' | 'R' | 'php' | 'python' | 'elixir' | 'c++' | 'lua'

Filter on this programming language

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

scope'all' | 'only_dev_deps' | 'exclude_dev_deps'

Filter on this scope. 'all' returns all packages, 'only_dev_deps' only dev dependency packages, 'exclude_dev_deps' excludes dev dependency packages

Response

An overview of all licenses and packages found in a code repository

{"stackTrail":"paths:/repositories/code/{code_repo_id}/licenses/export:get: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": ""
    }
  ]
}