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.

Effective triage involves comparing scanned binary file versions to spot regressions and analyzing individual findings for root cause analysis.

​
1. Regressions (Compare Images)

To identify what changed between two versions (e.g., a “Golden Master” vs. a new Release Candidate), use the comparison feature.

​
Workflow

  1. Identify the Baseline Image ID (e.g., previous stable version).
  2. Identify the Target Image ID (e.g., new build).
  3. Use the findings:gridList endpoint to filter by comparison IDs.
# Compare Baseline (Left) vs Target (Right)
curl -s -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "filters": [
      {"field": "compareLeftImageId", "value": "ID_BASELINE", "comparator": "equals"},
      {"field": "compareRightImageId", "value": "ID_TARGET", "comparator": "equals"}
    ]
  }' \
  "${BINARLY_API_URL}/api/v4/grids/findings:gridList"

​
2. Analyze Findings

Once you identify a critical finding, retrieve its full details.
  1. Get the findingId from the comparison results.
  2. Call the Get Finding endpoint (see Finding Reference).
curl -s \
  -H "Authorization: Bearer $TOKEN" \
  "${BINARLY_API_URL}/api/v4/products/${BINARLY_PRODUCT_ID}/findings/$FINDING_ID"
User Guides