Get Image

Retrieve details about a specific binary image, with optional finding counts.

When to Use This Endpoint

Use this endpoint to:

Verify an image upload was successful.
Check the basic metadata of a firmware image.
Get finding counts by severity with imageFields=findingsBySeverity.

Request

Endpoint

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

Path Parameters

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

Query Parameters

Parameter	Required	Description
`imageFields`	No	Comma-separated extra fields to include: `counts`, `findings`, `findingsBySeverity`

To download the findings report for an image, see Findings Report. Headers

Header	Value
`Authorization`	`Bearer <access_token>`

Example Request

BINARLY_PRODUCT_ID="01JQPGDX8QW0YJ0XEKV1EVG534"
IMAGE_ID="01JYJ0W0AACGC7QT1Q21SRWG94"

curl -s \
  -H "Authorization: Bearer ${TOKEN}" \
  "${BINARLY_API_URL}/api/v4/products/${BINARLY_PRODUCT_ID}/images/${IMAGE_ID}"

Response

{
  "id": "01JYJ0W0AACGC7QT1Q21SRWG94",
  "name": "Firmware v1.2",
  "version": "1.2.0",
  "createTime": "2024-01-20T10:00:00Z",
  "isArchived": false,
  "author": {
    "id": "01JV49FS1ZSGQ72NN6E0RXK3T0",
    "userId": "01JV49FS1ZSGQ72NN6E0RXK3T0",
    "email": "user@example.com",
    "status": "active"
  },
  "parent": "products/01JQPGDX8QW0YJ0XEKV1EVG534"
}

Field	Description
`id`	Unique image identifier
`name`	Human-readable name
`version`	Firmware version string
`createTime`	When the image was uploaded
`isArchived`	Whether the image is archived
`author`	User or service that uploaded the image
`author.email`	Email of the user or API client that uploaded the image
`parent`	Parent product resource path

With imageFields=counts,findingsBySeverity, the response also contains:

{
  "counts": {
    "dependenciesCount": 1,
    "findingTypeCounts": [{ "type": "unknownVulnerability", "count": 24 }],
    "kev": 0
  },
  "findingsBySeverity": {
    "critical": 0,
    "high": 24,
    "medium": 0,
    "low": 0,
    "unspecified": 0,
    "total": 24
  }
}

An image ID that doesn’t exist returns 404 with {"message":"Image not found"}.

To retrieve file checksums (SHA-256, MD5), see the SBOM Report endpoint, which includes hash information in the component inventory.

Overview

Use Cases

Reference

When to Use This Endpoint

Request

Example Request

Response