Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.binarly.io/llms.txt

Use this file to discover all available pages before exploring further.

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
ParameterRequiredDescription
productId✅Product ID
imageId✅Image ID
format✅Report format: cycloneDX or SPDX
Query Parameters
ParameterRequiredDescription
contentType✅Response content type: json
Headers
HeaderValue
AuthorizationBearer <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.