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.
List all software components (SBOM inventory) identified during the scan.
When to Use This Endpoint
Use this endpoint to:
- Retrieve a raw list of detected components for inventory management.
- Verify if a specific library version exists in your binary file.
Request
Endpoint
GET <BINARLY_API_URL>/api/v4/products/{productId}/images/{imageId}/scans/{scanId}/components
| Parameter | Required | Description |
|---|
productId | ✅ | Product ID |
imageId | ✅ | Image ID |
scanId | ✅ | Scan ID |
| 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}/scans/${SCAN_ID}/components"
Response
{
"components": [
{
"name": "OpenSSL",
"version": "1.1.1g",
"cpe": "cpe:2.3:a:openssl:openssl:1.1.1g:*:*:*:*:*:*:*"
}
]
}
| Field | Description |
|---|
name | Component name |
version | Detected version (optional) |
cpe | Common Platform Enumeration string (optional) |
