Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.binarly.io/llms.txt

Use this file to discover all available pages before exploring further.

Download a comprehensive security findings report in PDF, JSON, or CSV format.

​
When to Use This Endpoint

Use this endpoint to:
  • Generate human-readable PDF reports for stakeholders.
  • Export raw finding data (JSON/CSV) for custom analytics.

​
Request

​
PDF Format (GET)

GET <BINARLY_API_URL>/api/v4/products/{productId}/images/{imageId}
Query Parameters
ParameterRequiredDescription
contentType❌pdf
imageFields❌findings (include to get full report with all findings)

​
JSON Format (GET)

GET <BINARLY_API_URL>/api/v4/products/{productId}/images/{imageId}
Query Parameters
ParameterRequiredDescription
imageFields❌findings
Path Parameters (all formats)
ParameterRequiredDescription
productId✅Product ID
imageId✅Image ID
Headers
HeaderValue
AuthorizationBearer <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 (POST)
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).