Skip to main content
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}/findingsReport:pdf
Query Parameters
ParameterRequiredDescription
mode❌full or summary

​
JSON Format (POST)

[!IMPORTANT] The JSON format uses a POST request with an optional query body. 
POST <BINARLY_API_URL>/api/v4/products/{productId}/images/{imageId}/findingsReport:json
Request Body (optional) 
{}
Path Parameters (all formats)
ParameterRequiredDescription
productId✅Product ID
imageId✅Image ID
Headers
HeaderValue
AuthorizationBearer <access_token>

​
Example Requests

# PDF report
curl -s \
  -H "Authorization: Bearer ${TOKEN}" \
  "${BINARLY_API_URL}/api/v4/products/${BINARLY_PRODUCT_ID}/images/${IMAGE_ID}/findingsReport:pdf?mode=full" \
  -o report.pdf

# JSON report (POST)
curl -s -X POST \
  -H "Authorization: Bearer ${TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "${BINARLY_API_URL}/api/v4/products/${BINARLY_PRODUCT_ID}/images/${IMAGE_ID}/findingsReport:json"

​
Response

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