Get Scan

Retrieve details about a specific security scan, including its latest state.

When to Use This Endpoint

Use this endpoint to:

Poll the status of a running scan.
Look up when a scan was created and who started it.

The scan doesn’t include finding counts. For counts by severity, use Get Image with ?imageFields=counts,findingsBySeverity.

Request

Endpoint

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

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

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": {
    "id": "01JV49FS1ZSGQ72NN6E0RXK3T0",
    "userId": "01JV49FS1ZSGQ72NN6E0RXK3T0",
    "email": "user@example.com",
    "status": "active"
  },
  "latestScanState": {
    "id": "01JZ30D4K8M2XQ6V9T3NBR7HEW",
    "type": "done",
    "createTime": "2024-01-20T10:30:00Z",
    "parent": "products/01JQPGDX8QW0YJ0XEKV1EVG534/images/01JYJ0W0AACGC7QT1Q21SRWG94/scans/01JZ30CYZY52F5BPR3AAJ2DP89"
  }
}

Field	Description
`id`	Scan ID
`parent`	Parent resource path (product/image)
`createTime`	When the scan was created
`author`	User or API client that started the scan
`author.email`	Email of the user or API client
`author.status`	Account status: `active` or `archived`
`latestScanState`	Object containing scan status
`latestScanState.id`	ID of this state change
`latestScanState.type`	Status: `new`, `running`, `done`, `failed`, `cancelled`. See Scan States
`latestScanState.createTime`	When the scan entered this state

Overview

Use Cases

Reference

When to Use This Endpoint

Request

Example Request

Response