Retrieving vulnerability data using the REST API

Vulnerabilities affecting the installed base can be retrieved via the REST API using the vulnerabilities resource.

Retrieving the full vulnerabilities list

GET ot-base/api/v1/vulnerabilities

retrieves all vulnerabilities that affect the installed base, as listed in WORKFLOWS/CVE/List.

Reducing the scope by CVE priority

You can reduce the result set to CVEs of a particular priority with the priority keyword, followed by critical, high, medium, low, or combinations thereof. When filtering for multiple priority levels, separate the different values by comma. Example:

GET ot-base/api/v1/vulnerabilities?priority=critical,high

Reducing the scope by location

You can reduce the result set to vulnerabilities related to a specific location with the locationid keyword, followed by the location ID of the desired location. Example:

GET ot-base/api/v1/vulnerabilities?locationid=frk

Retrieving data for a particular vulnerability

GET ot-base/api/v1/vulnerabilities/{cveId}

retrieves data for a particular vulnerability is identified as a sub-resource, using its Common Vulnerability Enumerator (CVE).