SBOM

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

Get a project’s SBOM document

get

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.

Authorizations

BearerAuthAPIToken

Path parameters

org_idstring · uuidRequired

Unique identifier for an organization

project_idstring · uuidRequired

Unique identifier for a project

Query parameters

versionstringRequired

Requested API version

Example: 2021-06-04Pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$

formatstring · enumOptional

The desired SBOM format of the response.

Example: cyclonedx1.6+jsonPossible values:

Responses

200

Returns the SBOM document of a project

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

400

Bad Request: A parameter provided as a part of the request was invalid.

application/vnd.api+json

401

Unauthorized: the request requires an authentication token.

application/vnd.api+json

403

Forbidden: the request requires an authentication token with more or different permissions.

application/vnd.api+json

404

Not Found: The resource being operated on could not be found.

application/vnd.api+json

409

Conflict: The requested operation conflicts with the current state of the resource in some way.

application/vnd.api+json

500

Internal Server Error: An error was encountered while attempting to process the request.

application/vnd.api+json

get

HTTPcURLJavaScriptPython

GET /rest/orgs/{org_id}/projects/{project_id}/sbom HTTP/1.1
Host: api.snyk.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}