VEX Reports

Download the Vulnerability Exploitability eXchange (VEX) report, which details the exploitability status of vulnerabilities found in your binaries.

When to Use This Endpoint

Use this endpoint to:

Communicate which vulnerabilities are “fixed” or “not affected”.
Provide machine-readable security advisories to customers.

Request

Endpoint

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

Path Parameters

Parameter	Required	Description
`productId`	✅	Product ID
`imageId`	✅	Image ID
`format`	✅	Report format: `openVEX` or `cycloneDX`

Headers

Header	Value
`Authorization`	`Bearer <access_token>`

Example Request

curl -s \
  -H "Authorization: Bearer ${TOKEN}" \
  "${BINARLY_API_URL}/api/v4/products/${BINARLY_PRODUCT_ID}/images/${IMAGE_ID}/vexReport:openVEX" \
  -o vex.json

Response

Returns the VEX JSON document.

Overview

Use Cases

Reference

When to Use This Endpoint

Request

Example Request

Response

​When to Use This Endpoint

​Request

​Example Request

​Response

When to Use This Endpoint

Request

Example Request

Response