Vulnerability Endpoints

The vulnerability endpoints provide data on known vulnerabilities and what vulnerabilities may affect a given product.

Get Affected Projects - Returns all of a team's projects that are affected by a specified vulnerability.
Get Vulnerability - Returns the data of a given vulnerability.
Get Vulnerabilities - Returns the vulnerabilities that affect a given product.

Get Affected Projects

The v1/report/getAffectedProjects endpoint returns all of a team's projects are affected by a specified vulnerability and the total number of vulnerabilities affecting each of those projects.

Request Example:

curl -H "Authorization: Bearer TOKEN" \
https://api.ionchannel.io/v1/report/getAffectedProjects?id=TEAM_ID&external_id=CVE-2019-10744

Response Example:

{
  "data": [
    {
      "id": "abcd1234-ab12-ab12-ab12-abcde123456",
      "name": "Project Name 1",
      "version": "n/a",
      "vulnerabilities": 21
    },
    {
      "id": "abcd1234-ab12-ab12-ab12-abcde123456",
      "name": "Project Name 2",
      "version": "3.0.0",
      "vulnerabilities": 6
    }
  ],
  "meta": {
    "total_count": 0,
    "offset": 0
  }
}

Get Vulnerability

The v1/report/getAffectedProjects endpoint returns the information of a single vulnerability and the products affected by that vulnerability.

Request Example

curl -H "Authorization: Bearer TOKEN" \
https://api.ionchannel.io/v1/vulnerability/getVulnerability?external_id=CVE-2020-8203

Response Example

Get Vulnerabilities

The v1/vulnerability/getVulnerabilities endpoint allows you to search for vulnerabilities affecting a specified product and returns data on those vulnerabilities.

Request Example

curl -H "Authorization: Bearer TOKEN" \
https://api.ionchannel.io/v1/vulnerability/getVulnerabilities?product=lodash&version=4.17.19&offset=0&limit=10

Response Example