SBOM

This document uses the REST API. For more details, see the Authentication for API page.

Get a project’s SBOM document

This endpoint lets you retrieve the SBOM document of a software project. It supports the following formats:

• CycloneDX version 1.6 in JSON (set format to cyclonedx1.6+json).
• CycloneDX version 1.6 in XML (set format to cyclonedx1.6+xml).
• CycloneDX version 1.5 in JSON (set format to cyclonedx1.5+json).
• CycloneDX version 1.5 in XML (set format to cyclonedx1.5+xml).
• CycloneDX version 1.4 in JSON (set format to cyclonedx1.4+json).
• CycloneDX version 1.4 in XML (set format to cyclonedx1.4+xml).
• SPDX version 2.3 in JSON (set format to spdx2.3+json).

By default it will respond with an empty JSON:API response.

GEThttps://api.snyk.io/rest/orgs/{org_id}/projects/{project_id}/sbom

Path parameters

org_id*string (uuid)

Unique identifier for an organization

project_id*string (uuid)

Unique identifier for a project

Query parameters

Response

200400401403404409500

Returns the SBOM document of a project

Headers

Body

application/jsonapplication/vnd.api+jsonapplication/vnd.cyclonedx+jsonapplication/vnd.cyclonedx+xml

Other propertiesany

Request

JavaScriptCurlPython

const response = await fetch('https://api.snyk.io/rest/orgs/{org_id}/projects/{project_id}/sbom?version=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

400401403404409500

{
  "errors": [
    {
      "detail": "Permission denied for this resource",
      "status": "403"
    }
  ],
  "jsonapi": {
    "version": "1.0"
  }
}