Get vulnerabilities of a device v3.1
| API version | 3.1 |
|---|---|
| Last Update | 04/18/2023 |
| Authentication | YES |
| HTTP Method | POST |
| Content Type | application/json |
| Rate limited | YES |
| Requests per rate limit | 10 requests/min |
| Response Format | JSON |
| Change History | Added support multiple CVSS scores on the response data |
Use to fetch detected vulnerabilities that are associated to a device
API URL
Request Parameters
| Key | Datatype | Parameter Type | Required | Description | Default |
|---|---|---|---|---|---|
| access_token | string | URL | Yes | access token which archived from OAuth authentication step | |
| id | string | Body | Yes | The Device ID or MAC Address of a device you want to fetch vulnerabilities | |
| verbose | int | Body | Optional | 1 - detailed vulnerability information will return in response 0 - response does not include detailed information, only CVE IDs are included in a response | 0 |
| limit | int | Body | Optional | Specific maximum number of vulnerabilities will be returned in the response. The value should be in [1,100]. | 100 |
| page | int | Body | Optional | A page you want to get data | 1 |
| filter | object | Body | Optional | Specify filter criteria | |
| filter.score_type | string | Body | Optional | Specify what score type used to filter along with the field filter.score Value can be: "opswat_score", "cvss2_ score", "cvss3_score" | opswat_score |
| filter.severity | array | Body | Optional | Filter vulnerabilities based on score_type:
| all based on selected score_type |
Response HTTP Code
See APIs
Response Parameters
| Key | DataType | Description |
|---|---|---|
| cve_id | string | CVE ID |
| severity | string | vulnerability severity. Value can be: "critical", "important", "moderate", "low", "unknown", "high", "medium" |
| summary | string | Vulnerability summary |
| update_date | string | The last date NIST updated this vulnerability |
| publish_date | string | The date NIST published this vulnerability |
| opswat_score | string | OPSWAT score |
| cvss2_score | string | CVSS 2 score |
| cvss3_score | number | CVSS 3 score |
| remediation | string | Suggestion to remediate the CVE |
| cwe_id | string | A CWE(Common Weakness Enumeration) group identification string. |
Example
Example Request:
Example Response with verbose as OFF
Example Response with verbose as ON
History
| Action | Version | URL |
|---|---|---|
| Get Vulnerabilities of a device | 3.0 | Get vulnerabilities of a device v3.0 |
Was this page helpful?