REST API Reference v2.1 -- SBOM Management
POST /sboms
Uploads a Software Bill of Materials for analysis. Accepts CycloneDX (JSON/XML) and SPDX (JSON/tag-value) formats. Requires sboms:write scope. Send the SBOM document as the request body with Content-Type: application/json (for JSON formats) or Content-Type: application/xml (for XML formats). Include X-SBOM-Format: cyclonedx|spdx and X-SBOM-Project: proj_abc headers.
Response: {"id": "sbom_xyz", "format": "cyclonedx", "version": "1.5", "components_count": 342, "status": "analyzing", "project_id": "proj_abc", "created_at": "2026-02-25T10:00:00Z"}. After upload, the platform correlates components against the NVD, OSV, and GitHub Advisory databases. Analysis typically completes within 60 seconds.
GET /sboms/:id/vulnerabilities
Returns vulnerabilities found in an SBOM's components. Each vulnerability includes CVE identifier, CVSS and EPSS scores, affected component version ranges, and available fix versions. Query parameters: severity, has_fix (boolean), epss_above (float, filter by minimum EPSS score), sort (severity, epss_score, component), page, limit.
Response: {"data": [{"cve": "CVE-2025-4321", "severity": "high", "cvss_score": 8.1, "epss_score": 0.43, "component": {"name": "express", "version": "4.18.2", "type": "npm"}, "affected_versions": "<4.19.0", "fix_version": "4.19.0", "published_at": "2025-02-15T00:00:00Z"}]}. Use the epss_above filter to focus on vulnerabilities with high exploitation probability, reducing noise from theoretical vulnerabilities that are unlikely to be exploited.
GET /sboms/:id/licenses
Returns license information for all components in the SBOM with compliance checking against your organization's license policy. Each component includes its declared license, the license family (permissive, copyleft, proprietary), and whether it complies with your policy.
Response: {"data": [{"component": "react", "version": "18.2.0", "license": "MIT", "license_family": "permissive", "compliant": true}, {"component": "ghostscript", "version": "10.0.0", "license": "AGPL-3.0", "license_family": "copyleft", "compliant": false, "policy_violation": "AGPL-3.0 not allowed for SaaS products"}]}. Configure your license policy via PUT /org/settings/license-policy with allowed and blocked license lists.
Links in this article were last verified on March 2025.