Skip to main content

API Overview

The CVD Portal REST API gives programmatic access to a part of the portal functions. The API needs the Enterprise plan, except GET /compliance/next-task and GET /compliance/next-deadline, which work on the Reporting plan or higher. Each request uses a Bearer API key. See API Authentication.

Endpoints​

All paths start with /api/v1.

Method and pathPurposeScope
POST /vulnerabilitiesSubmit a vulnerability reportsubmissions:write
GET /vulnerabilities/exportExport up to 100 reports as JSONread
GET /vulnerabilities/{id}/article14Read the Article 14 status of a reportread
GET, POST /productsList or create productsread, products:write
GET, POST /sbomRead SBOM metadata or push an SBOMread, sbom:write
POST /scan/sarifPush SARIF scan findingssarif:write
GET /compliance/statusRead the compliance statusread
GET /compliance/gapsRead the open compliance gapsread
GET /compliance/next-task, GET /compliance/next-deadlineRead the next task or deadlineread
GET /compliance/mappingsRead the CRA requirement mappingsread
GET, POST /compliance/assessments, GET /compliance/assessments/oscalRead or start assessments, export OSCALread and others
POST /jobs, GET /jobs/{id}Start and read background jobsvaries
POST /webhooks/registerRegister a webhookwebhooks:write
GET /gdpr/exportExport all company data as JSONgdpr:export

Limits​

  • The API cannot change a report after you create it. For example, it cannot update the status or the CVSS score.
  • For AI agents, CVD Portal also has an MCP server. See MCP Server.