Skip to main content

Updates to Existing APIs

The following section describes updates that have occurred to existing APIs in this release:

ResourceAPI Name/EndpointMethodFunction Change Description
ComponentGet Component
/components/{componentId}
GETThe response now includes only the advisory vulnerabilities, along with their referenced CVE (Common Vulnerabilities and Exposures) vulnerabilities. The referenced CVE vulnerabilities are indicated by the new property cveReferences.
Additionally, the response now provides only the count of advisory vulnerabilities.
ComponentGet Component version vulnerabilities
/components/{versionId}/vulnerabilities
GETThe response now includes vulnerability information based solely on advisory vulnerabilities, along with their referenced CVE (Common Vulnerabilities and Exposures) vulnerabilities. The referenced CVE vulnerabilities are indicated by the new property cveReferences.
Project APIGet Project Inventory
/project/inventory/{projectId}
GETThe response now includes vulnerability information based solely on advisory vulnerabilities, along with their referenced CVE (Common Vulnerabilities and Exposures) vulnerabilities. The referenced CVE vulnerabilities are indicated by the new property cveReferences.
Project APIGet Project Information
/projects/{projectId}

Get Inventory Summary of the project
/projects/{projectId}/inventorySummary
GETThe response now includes the vulnerability count based solely on advisory vulnerabilities. All referenced CVE (Common Vulnerabilities and Exposures) vulnerabilities are not included in the count.
Project APIImport Project Data
/projects/{projectId}/import
POSTThe request no longer supports importing a .json data file that was exported from a different Code Insight version than the current installation.
VulnerabilitySuppress vulnerability
/vulnerability/suppress
POSTThe request now allows you to suppress only advisory vulnerabilities at both the project and global levels. Suppressing an advisory vulnerability automatically suppresses all its referenced CVE (Common Vulnerabilities and Exposures) vulnerabilities.
VulnerabilityUnSuppress vulnerability
/vulnerability/unSuppress
POSTThe request now allows you to unsuppress only advisory vulnerabilities at both the project and global levels. Unsuppressing an advisory vulnerability automatically unsuppresses all its referenced CVE (Common Vulnerabilities and Exposures) vulnerabilities.
VulnerabilityGet suppressed vulnerabilities
/vulnerability/suppress
GETThe response now includes only the list of advisory vulnerabilities that are suppressed at both the project and global levels. The CVE (Common Vulnerabilities and Exposures) vulnerabilities are not included in the response.
VulnerabilityGet vulnerability suppress details
/vulnerability/suppress/details
GETThe response now includes only advisory vulnerabilities details that are suppressed at the project level. The CVE (Common Vulnerabilities and Exposures) vulnerabilities details are not included in the response.
Inventory APIGet details of an inventory
/inventories/{inventoryId}

Get the inventories of file/folder ids
/inventories/search

Get vulnerability details of an inventory
/inventories/{inventoryId}/vulnerabilities
GETThe response now includes vulnerability information based solely on advisory vulnerabilities, along with their referenced CVE (Common Vulnerabilities and Exposures) vulnerabilities. The referenced CVE vulnerabilities are indicated by the new property cveReferences.