List Images

List all binary images associated with a product.

When to Use This Endpoint

Use this endpoint to iterate through your firmware inventory or find a specific image ID based on version or name.

Request

Endpoint

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

Path Parameters

Parameter	Required	Description
`productId`	Yes	Product ID to list images for

Use - as productId to list the images of all products you can access. Headers

Header	Value
`Authorization`	`Bearer <access_token>`

Example Request

BINARLY_PRODUCT_ID="01JQPGDX8QW0YJ0XEKV1EVG534"

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

Response

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

Field	Description
`images`	Array of image objects
`images[].id`	Image ID (ULID)
`images[].name`	Image name
`images[].version`	Image version, an empty string when not set
`images[].createTime`	When the image was created
`images[].isArchived`	Whether the image is archived
`images[].parent`	Parent product resource path
`images[].author`	User or service that uploaded the image, with `email` and `id`

A product ID that doesn’t exist returns 200 with an empty images array, not 404. Use Get Product to check that a product exists.

Overview

Use Cases

Reference

When to Use This Endpoint

Request

Example Request

Response