Upload VEX
Upload a Vulnerability Exploitability eXchange (VEX) document to DevGuard. VEX documents allow you to communicate the status of vulnerabilities in your software components to DevGuard, enabling more accurate vulnerability tracking and compliance reporting.
Prerequisites
Before you begin, ensure you have:
- Docker installed on your system
- A personal access token from DevGuard (create one in user settings)
- A repository created in DevGuard
- An existing VEX document in CycloneDX format (JSON or XML)
Upload VEX Document
Upload a VEX document to update vulnerability statuses:
Replace vex.json with the path to your VEX document. The scanner accepts CycloneDX VEX (JSON or XML). To import CSAF or OpenVEX, add the document as an upstream source URL instead — see Import VEX from Files & Suppliers.
Replace myorg/projects/myproject/assets/myrepo with your repository's slug. You can copy this from the URL when viewing your repository in the DevGuard UI.
What DevGuard Does with VEX
- Parses VEX Document: Reads and validates your CycloneDX VEX file
- Extracts Vulnerability Status: Identifies the status (affected, not affected, fixed, under investigation) for each vulnerability
- Updates Vulnerability Records: Syncs the VEX status information with matching vulnerabilities in DevGuard
- Creates Audit Trail: Records VEX uploads as events for compliance tracking
- Processes External References: Handles external VEX references if the document includes them
Verify it worked: Navigate to your repository in DevGuard: you'll see the status of your vulnerabilities has been updated according to the VEX document, with audit events showing the changes made.
CI/CD Integration
For automated VEX uploads in CI/CD pipelines, DevGuard provides ready-to-use integrations:
- GitHub Actions: See Scan with GitHub Actions for setup instructions
- GitLab CI: See Scan with GitLab CI for setup instructions
Advanced Options
Specify which artifact this VEX applies to (you can find your artifacts in your DevGuard repository):
Set a custom origin to track where the VEX came from:
Specify Git reference information:
These flags help DevGuard track which branch or tag the scan is associated with. DevGuard will attempt to auto-detect Git information from the current directory if these flags are not specified.