Page tree


In This Document 



Have a suggestion for the Armor Knowledge Base? Send a message to kb@armor.com.




Overview

This topic only applies to Armor Anywhere users.

The Get Vulnerability Scans Data for Affected Virtual Machines API retrieves the virtual machine name and coreInstanceId for a specified report. In short, you can use this API to determine the virtual machine and coreInstanceId that are included in a specified report. 

You can use the Get Vulnerability Scans API to find the scanReportId, which will return as id.

You can use the API to find the vulnerabilityId, which will return as id.



Sample request

GET https://api.armor.com/vulnerability-scan/vms-affected/1/222

Input

The following table describes the different parts of this API call: 

API Call / URLMethod / Type
/vulnerability-scan/vms-affected/{vulnerabilityid}/{scanReportId}GET

The following table describes the parameter (or parameters) for this API call:

ParameterDescriptionFormatRequired or optionalExample
vulnerabilityID

The ID of the specific vulnerability

You can use the Get Vulnerability Scan Details for a Report API to find the vulnerabilityId, which will return as vulnerabilityId.

IntegerRequired1
scanReportId

The ID for the specific scan report.

You can use the Get Vulnerability Scans API to find the reportId / scanReportId, which will return as id.

IntegerRequired222

Sample return

StatusResponse
200
{
  "vmName": "100-064-002-010",
  "coreInstanceId": "addfd13-dsfdf-13434-13adfd"
}
400
Bad Request