|
| 1 | +--- |
| 2 | +slug: vcio-migration-announcement-aboutcode |
| 3 | +title: VulnerableCode API Deprecation and V3 Introduction |
| 4 | +authors: [tg1999] |
| 5 | +tags: [vcio, vulnerabilities, advisories, purl, api] |
| 6 | +hide_table_of_contents: false |
| 7 | +--- |
| 8 | + |
| 9 | +# VulnerableCode API Deprecation and V3 Introduction |
| 10 | + |
| 11 | +VulnerableCode (public.vulnerablecode.io) is planning to deprecate V1 and V2 API by the end of Q2 2026 (June 20, 2026) with the V3 API and UI to be introduced by the end of January 2026. |
| 12 | + |
| 13 | +--- |
| 14 | + |
| 15 | +## Why this new API |
| 16 | + |
| 17 | +The existing V1 and V2 APIs are both based on the “vulnerabilities” model, designed to aggregate information from multiple advisory sources based on identifiers and aliases. Due to the combination of various sources, it is difficult to determine which source is correct and this may result in data from one source overwriting data from another source. |
| 18 | + |
| 19 | +--- |
| 20 | + |
| 21 | +## What to expect from this new API and UI |
| 22 | + |
| 23 | +Moving forward, VulnerableCode will report “advisories” for packages and not “vulnerabilities”. |
| 24 | + |
| 25 | +Currently if a package has 4 advisories and those 4 advisories were correlated with each other by their aliases and identifiers, we report a single vulnerability affecting that package. The new approach in V3 will report 4 individual advisories. |
| 26 | + |
| 27 | +The new “advisories” model introduces an Advisory ID (AVID) for each advisory in VulnerableCode. An AVID will have different components like the source and the natural unique identifier used at that source. So for example if we are importing an advisory from “nodejs_security_wg” and it’s identified by its ID “123”, the AVID will be “nodejs_security_wg/123”. |
| 28 | + |
| 29 | +--- |
| 30 | + |
| 31 | +## Plan and Timeline |
| 32 | + |
| 33 | +We are planning to complete the following tasks by the end of January 2026: |
| 34 | + |
| 35 | +- Redesigning the API and UI |
| 36 | +- Migrating our existing data sources |
| 37 | +- Documenting the V3 API and the new UI |
| 38 | + |
| 39 | +--- |
| 40 | + |
| 41 | +## Current Status |
| 42 | + |
| 43 | +https://public2.vulnerablecode.io/v2 uses the new advisory based UI and |
| 44 | +https://public2.vulnerablecode.io/api/v3/ uses new API, but it is still under development and not ready for production use. |
| 45 | + |
| 46 | +--- |
| 47 | + |
| 48 | +## Migration Progress |
| 49 | + |
| 50 | +You can track the progress of migration here: |
| 51 | +https://github.com/orgs/aboutcode-org/projects/52/views/48 |
0 commit comments