CBOM Reports

Download the Cryptographic Bill of Materials (CBOM), listing all cryptographic assets found in the binary file.

When to Use This Endpoint

Use this endpoint to:

Inventory cryptographic algorithms and keys.
Identify weak or non-compliant cryptography (e.g., Post-Quantum Readiness).

Request

Endpoint

GET <BINARLY_API_URL>/api/v4/products/{productId}/images/{imageId}/cbomReport:{format}

Path Parameters

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

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}/cbomReport:cycloneDX" \
  -o cbom.json

Response

Returns the CBOM 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