Get SBOM
This endpoint lets you retrieve the SBOM document of a software project. It supports the following formats:
- CycloneDX version 1.4 in JSON (set
format
tocyclonedx1.4+json
). - CycloneDX version 1.4 in XML (set
format
tocyclonedx1.4+xml
). - SPDX version 2.3 in JSON (set
format
tospdx2.3+json
).
By default it will respond with an empty JSON:API response.
Parameters
Parameter | Description |
---|---|
Format | The desired SBOM format of the response. |
Organization ID | Unique identifier for an organization. |
Project ID | Unique identifier for a project. |
Example Output
{
"jsonapi": {
"version": "1.0"
},
"data": {
"id": "4f45cb30-cf00-4980-80d4-da65cacbdaee",
"type": "sbom"
}
}
Workflow Library Example
Get Sbom with Snyk and Send Results Via Email