Export CycloneDX SBOM (Beta)

Export the packages of a full scan as a CycloneDX SBOM

Packages of every ecosystem are exported. A package without a name, a version or a valid package URL is left out.

Vulnerabilities, with "include_vulnerabilities=true":

  • Advisories: an advisory is listed with the components it affects.
  • Reachability: when the scan has a reachability result for a component, "analysis" reports it. Unreachable code is "not_affected" with justification "code_not_reachable", reachable code is "exploitable", with a call path in "analysis.detail" when one was recorded, and a result without a conclusion is "in_triage". A component analysed in several workspaces is reachable if any of them reaches the code, and unreachable only if all of them find it so. Components of one advisory with different results are listed in separate entries, and components with no result share an entry with no "analysis".
  • Applied Socket patches: an advisory fixed by the applied patch gets an entry of its own with "analysis.state" set to "resolved_with_pedigree". Its "analysis.detail" names the patch and, when the scan has one, gives the reachability result.

Applied Socket patches:

  • Components: a package with an applied Socket patch carries a "pedigree.patches" entry that links the patch and lists the advisories it resolves, plus a "socket:patch:uuid" property. The component purl stays the upstream purl. Its "supplier" is Socket Inc and its "publisher" stays the original author.

This endpoint consumes 1 unit of your quota.

This endpoint requires the following org token scopes:

  • report:read
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The slug of the organization

string
required

The full scan ID

Query Params
string
Defaults to OWASP Foundation

The person(s) who created the BOM.
Set this value if you're intending the modify the BOM and claim authorship.

string

Dependency track project group

string

Dependency track project name. Defaults to the name of the repository the scan belongs to, prefixed with its workspace when it has one

string

Dependency track project version

string

Dependency track project id. Either provide the id or the project name and version together

string
Defaults to false

Include vulnerabilities in the SBOM, each with its reachability and patch status when the scan has them

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json