List Components

List the components identified during the scan, as a tree that follows how the binary image was unpacked.

When to Use This Endpoint

Use this endpoint to:

Retrieve the structure of a binary image: the files, modules and nested components found inside it.
Look up the component IDs and paths for further analysis.

The response doesn’t include library versions or CPE identifiers. For versions, CPE and PURL, use the SBOM report.

Request

Endpoint

GET <BINARLY_API_URL>/api/v4/products/{productId}/images/{imageId}/scans/{scanId}/components

Path Parameters

Parameter	Required	Description
`productId`	Yes	Product ID
`imageId`	Yes	Image ID
`scanId`	Yes	Scan ID

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}/scans/${SCAN_ID}/components"

Response

The top level holds the uploaded file. Each component can contain its own components.

{
  "components": [
    {
      "id": "57777798-2a42-4759-a6ef-f86c06fcf2d7",
      "name": "firmware.bin",
      "path": "",
      "components": [
        {
          "id": "0214f849-a7c9-43f6-9beb-67c091543e09",
          "name": "SecurityStubDxe",
          "path": ""
        }
      ]
    }
  ]
}

Field	Description
`id`	Component ID
`name`	Component name
`path`	Path of the component inside its parent
`components`	Nested components (optional)
`containerPath`	Path of the container file (optional)
`virtualPath`	Virtual path of the component (optional)
`kind`	Component kind (optional)
`attributes`	Additional component attributes (optional)
`md5`	MD5 hash of the component (optional)
`sha1`	SHA-1 hash of the component (optional)
`sha256`	SHA-256 hash of the component (optional)

Overview

Use Cases

Reference

When to Use This Endpoint

Request

Example Request

Response