Get Scan - Binarly Transparency Platform

Retrieve details about a specific security scan, including the status and high-level statistics.

When to Use This Endpoint

Use this endpoint to:

Poll the status of a running scan.
Retrieve summary statistics like finding counts and risk scores.

Request

Endpoint

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

Path Parameters

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

Headers

Header	Value
`Authorization`	`Bearer <access_token>`

Example Request

BINARLY_PRODUCT_ID="01JQPGDX8QW0YJ0XEKV1EVG534"
IMAGE_ID="01JYJ0W0AACGC7QT1Q21SRWG94"
SCAN_ID="01JZ30CYZY52F5BPR3AAJ2DP89"

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

Response

{
  "id": "01JZ30CYZY52F5BPR3AAJ2DP89",
  "parent": "products/01JQPGDX8QW0YJ0XEKV1EVG534/images/01JYJ0W0AACGC7QT1Q21SRWG94",
  "createTime": "2024-01-20T10:00:00Z",
  "author": "user@example.com",
  "latestScanState": {
    "type": "completed",
    "updateTime": "2024-01-20T10:30:00Z"
  }
}

Field	Description
`id`	Scan ID
`parent`	Parent resource path (product/image)
`createTime`	When the scan was created
`author`	User or service that initiated the scan
`latestScanState`	Object containing scan status
`latestScanState.type`	Status: `in_progress`, `completed`, `failed`, `cancelled`
`latestScanState.updateTime`	When the status was last updated

⌘I