Findings Report

Download a security findings report in PDF or JSON format.

When to Use This Endpoint

Use this endpoint to:

Generate human-readable PDF reports for stakeholders.
Export raw finding data (JSON) for custom analytics.

For a CSV export, use the findings grid with ?contentType=csv.

Request

PDF Format (GET)

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

Query Parameters

Parameter	Required	Description
`contentType`	No	`pdf`
`imageFields`	No	`findings` (include to get full report with all findings)

JSON Format (GET)

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

Query Parameters

Parameter	Required	Description
`imageFields`	No	`findings`

Path Parameters (all formats)

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

Headers

Header	Value
`Authorization`	`Bearer <access_token>`

Example Requests

# PDF report (full)
curl -s \
  -H "Authorization: Bearer ${TOKEN}" \
  "${BINARLY_API_URL}/api/v4/products/${BINARLY_PRODUCT_ID}/images/${IMAGE_ID}?contentType=pdf&imageFields=findings" \
  -o report.pdf

# JSON report
curl -s \
  -H "Authorization: Bearer ${TOKEN}" \
  "${BINARLY_API_URL}/api/v4/products/${BINARLY_PRODUCT_ID}/images/${IMAGE_ID}?imageFields=findings"

Response

Returns the requested file content (binary PDF or text/json).

Overview

Use Cases

Reference