Export OpenVEX Document (Beta)

Export vulnerability exploitability data as an OpenVEX v0.2.0 document.

OpenVEX (Vulnerability Exploitability eXchange) documents communicate the
exploitability status of vulnerabilities in software products. This export
includes:

  • Patch data: Vulnerabilities fixed by applied Socket patches are marked as "fixed". The status notes name the patch and, when the scan has one, give the reachability result
  • Reachability analysis: Code reachability determines if vulnerable code is exploitable:
  • Unreachable code → "not_affected" with justification "vulnerable_code_not_in_execute_path"
  • Reachable code → "affected", with a call path in the status notes when one was recorded
  • Unknown/pending → "under_investigation"
  • No reachability result → "affected"
  • A package analysed in several workspaces → "affected" if any of them reaches the code, "not_affected" only if all of them find it unreachable
  • What to do: An "affected" statement carries an "action_statement". It names the first fixed version when the advisory lists one

Each statement covers one package and one vulnerability. A package the scan
lists more than once, such as a Python release with several distribution
files, gets one statement, as it gets one component in the CycloneDX export:
"fixed" when the patch applied to it fixes the vulnerability, otherwise the
reachability result that prevails across its listings. A listing without
a reachability result is left out of that. Advisories that share a CVE
share a statement, which is "fixed" only when the patch fixes all of them.

This endpoint consumes 1 unit of your quota.

This endpoint requires the following org token scopes:

  • report:read
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The slug of the organization

string
required

The full scan ID

Query Params
string
Defaults to Socket Security

The author of the VEX document. Should be an individual or organization.

string
Defaults to VEX Generator

The role of the document author (e.g., "VEX Generator", "Security Team").

string

Custom IRI for the VEX document. If not provided, a default IRI will be generated.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json