Export SPDX SBOM (Beta)

Export the packages of a full scan as a SPDX SBOM

Packages of every ecosystem are exported. A package without a name, a version or a valid package URL is left out. A scan that contains an SPDX file is the exception: see "Uploaded SPDX files" below.

Applied Socket patches:

  • Packages: a package with an applied Socket patch carries a "SECURITY" external reference of type "fix" that links the patch. Its comment names the advisories the patch fixes. Its "supplier" is Socket Inc and its "originator" is the original author.
  • Vulnerability status: SPDX 2.3 has no status field, so "include_vulnerabilities" has no effect here. Use the OpenVEX export for machine-readable status.
  • Uploaded SPDX files: a scan that contains an SPDX file is exported from that file, limited to the fields this endpoint returns, and carries no patch references.

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

Has no effect: SPDX 2.3 has no field for vulnerability status. Use the OpenVEX export for it

Responses

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