SBOM Reports

Download the Software Bill of Materials (SBOM) for a specific binary image in industry-standard formats.

When to Use This Endpoint

Use this endpoint to:

Generate compliance artifacts for releases.
Import your firmware inventory into other security tools.

Request

Endpoint

GET <BINARLY_API_URL>/api/v4/products/{productId}/images/{imageId}/sbomReport:{format}?contentType=json

Path Parameters

Parameter	Required	Description
`productId`	✅	Product ID
`imageId`	✅	Image ID
`format`	✅	Report format: `cycloneDX` or `SPDX`

Query Parameters

Parameter	Required	Description
`contentType`	✅	Response content type: `json`

Headers

Header	Value
`Authorization`	`Bearer <access_token>`

Example Request

curl -s \
  -H "Authorization: Bearer ${TOKEN}" \
  "${BINARLY_API_URL}/api/v4/products/${BINARLY_PRODUCT_ID}/images/${IMAGE_ID}/sbomReport:cycloneDX?contentType=json" \
  -o sbom.json

Response

Returns the SBOM JSON document.

Overview

Use Cases

Reference

When to Use This Endpoint

Request

Example Request

Response

​When to Use This Endpoint

​Request

​Example Request

​Response

When to Use This Endpoint

Request

Example Request

Response