# REST Resource: projects.locations.instances.vulnerabilityReports

- [Resource: VulnerabilityReport](https://docs.cloud.google.com/compute/docs/osconfig/rest/v1/projects.locations.instances.vulnerabilityReports#VulnerabilityReport)
  - [JSON representation](https://docs.cloud.google.com/compute/docs/osconfig/rest/v1/projects.locations.instances.vulnerabilityReports#VulnerabilityReport.SCHEMA_REPRESENTATION)
- [Vulnerability](https://docs.cloud.google.com/compute/docs/osconfig/rest/v1/projects.locations.instances.vulnerabilityReports#Vulnerability)
  - [JSON representation](https://docs.cloud.google.com/compute/docs/osconfig/rest/v1/projects.locations.instances.vulnerabilityReports#Vulnerability.SCHEMA_REPRESENTATION)
- [Details](https://docs.cloud.google.com/compute/docs/osconfig/rest/v1/projects.locations.instances.vulnerabilityReports#Details)
  - [JSON representation](https://docs.cloud.google.com/compute/docs/osconfig/rest/v1/projects.locations.instances.vulnerabilityReports#Details.SCHEMA_REPRESENTATION)
- [CVSSv3](https://docs.cloud.google.com/compute/docs/osconfig/rest/v1/projects.locations.instances.vulnerabilityReports#CVSSv3)
  - [JSON representation](https://docs.cloud.google.com/compute/docs/osconfig/rest/v1/projects.locations.instances.vulnerabilityReports#CVSSv3.SCHEMA_REPRESENTATION)
- [AttackVector](https://docs.cloud.google.com/compute/docs/osconfig/rest/v1/projects.locations.instances.vulnerabilityReports#AttackVector)
- [AttackComplexity](https://docs.cloud.google.com/compute/docs/osconfig/rest/v1/projects.locations.instances.vulnerabilityReports#AttackComplexity)
- [PrivilegesRequired](https://docs.cloud.google.com/compute/docs/osconfig/rest/v1/projects.locations.instances.vulnerabilityReports#PrivilegesRequired)
- [UserInteraction](https://docs.cloud.google.com/compute/docs/osconfig/rest/v1/projects.locations.instances.vulnerabilityReports#UserInteraction)
- [Scope](https://docs.cloud.google.com/compute/docs/osconfig/rest/v1/projects.locations.instances.vulnerabilityReports#Scope)
- [Impact](https://docs.cloud.google.com/compute/docs/osconfig/rest/v1/projects.locations.instances.vulnerabilityReports#Impact)
- [Reference](https://docs.cloud.google.com/compute/docs/osconfig/rest/v1/projects.locations.instances.vulnerabilityReports#Reference)
  - [JSON representation](https://docs.cloud.google.com/compute/docs/osconfig/rest/v1/projects.locations.instances.vulnerabilityReports#Reference.SCHEMA_REPRESENTATION)
- [Item](https://docs.cloud.google.com/compute/docs/osconfig/rest/v1/projects.locations.instances.vulnerabilityReports#Item)
  - [JSON representation](https://docs.cloud.google.com/compute/docs/osconfig/rest/v1/projects.locations.instances.vulnerabilityReports#Item.SCHEMA_REPRESENTATION)
- [VulnerabilitySeverityLevel](https://docs.cloud.google.com/compute/docs/osconfig/rest/v1/projects.locations.instances.vulnerabilityReports#VulnerabilitySeverityLevel)
- [Methods](https://docs.cloud.google.com/compute/docs/osconfig/rest/v1/projects.locations.instances.vulnerabilityReports#METHODS_SUMMARY)

## Resource: VulnerabilityReport

This API resource represents the vulnerability report for a specified Compute Engine virtual machine (VM) instance at a given point in time.

For more information, see [Vulnerability reports](https://cloud.google.com/compute/docs/instances/os-inventory-management#vulnerability-reports).

| JSON representation |
|---|
| ``` { "name": string, "vulnerabilities": [ { object (`https://docs.cloud.google.com/compute/docs/osconfig/rest/v1/projects.locations.instances.vulnerabilityReports#Vulnerability`) } ], "updateTime": string, "highestUpgradableCveSeverity": enum (`https://docs.cloud.google.com/compute/docs/osconfig/rest/v1/projects.locations.instances.vulnerabilityReports#VulnerabilitySeverityLevel`) } ``` |

| Fields ||
|---|---|
| `name` | `string` Output only. The `vulnerabilityReport` API resource name. Format: `projects/{project_number}/locations/{location}/instances/{instance_id}/vulnerabilityReport` |
| `vulnerabilities[]` | ``object (`https://docs.cloud.google.com/compute/docs/osconfig/rest/v1/projects.locations.instances.vulnerabilityReports#Vulnerability`)`` Output only. List of vulnerabilities affecting the VM. |
| `updateTime` | ``string (`https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` format)`` Output only. The timestamp for when the last vulnerability report was generated for the VM. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: `"2014-10-02T15:01:23Z"`, `"2014-10-02T15:01:23.045123456Z"` or `"2014-10-02T15:01:23+05:30"`. |
| `highestUpgradableCveSeverity` | ``enum (`https://docs.cloud.google.com/compute/docs/osconfig/rest/v1/projects.locations.instances.vulnerabilityReports#VulnerabilitySeverityLevel`)`` Output only. Highest level of severity among all the upgradable vulnerabilities with CVEs attached. |

## Vulnerability

A vulnerability affecting the VM instance.

| JSON representation |
|---|
| ``` { "details": { object (`https://docs.cloud.google.com/compute/docs/osconfig/rest/v1/projects.locations.instances.vulnerabilityReports#Details`) }, "installedInventoryItemIds": [ string ], "availableInventoryItemIds": [ string ], "createTime": string, "updateTime": string, "items": [ { object (`https://docs.cloud.google.com/compute/docs/osconfig/rest/v1/projects.locations.instances.vulnerabilityReports#Item`) } ] } ``` |

| Fields ||
|---|---|
| `details` | ``object (`https://docs.cloud.google.com/compute/docs/osconfig/rest/v1/projects.locations.instances.vulnerabilityReports#Details`)`` Contains metadata as per the upstream feed of the operating system and NVD. |
| `installedInventoryItemIds[] (deprecated)` | `string` > [!WARNING] > This item is deprecated! Corresponds to the `INSTALLED_PACKAGE` inventory item on the VM. This field displays the inventory items affected by this vulnerability. If the vulnerability report was not updated after the VM inventory update, these values might not display in VM inventory. For some distros, this field may be empty. |
| `availableInventoryItemIds[] (deprecated)` | `string` > [!WARNING] > This item is deprecated! Corresponds to the `AVAILABLE_PACKAGE` inventory item on the VM. If the vulnerability report was not updated after the VM inventory update, these values might not display in VM inventory. If there is no available fix, the field is empty. The `inventory_item` value specifies the latest `SoftwarePackage` available to the VM that fixes the vulnerability. |
| `createTime` | ``string (`https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` format)`` The timestamp for when the vulnerability was first detected. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: `"2014-10-02T15:01:23Z"`, `"2014-10-02T15:01:23.045123456Z"` or `"2014-10-02T15:01:23+05:30"`. |
| `updateTime` | ``string (`https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` format)`` The timestamp for when the vulnerability was last modified. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: `"2014-10-02T15:01:23Z"`, `"2014-10-02T15:01:23.045123456Z"` or `"2014-10-02T15:01:23+05:30"`. |
| `items[]` | ``object (`https://docs.cloud.google.com/compute/docs/osconfig/rest/v1/projects.locations.instances.vulnerabilityReports#Item`)`` List of items affected by the vulnerability. |

## Details

Contains metadata information for the vulnerability. This information is collected from the upstream feed of the operating system.

| JSON representation |
|---|
| ``` { "cve": string, "cvssV2Score": number, "cvssV3": { object (`https://docs.cloud.google.com/compute/docs/osconfig/rest/v1/projects.locations.instances.vulnerabilityReports#CVSSv3`) }, "severity": string, "description": string, "references": [ { object (`https://docs.cloud.google.com/compute/docs/osconfig/rest/v1/projects.locations.instances.vulnerabilityReports#Reference`) } ] } ``` |

| Fields ||
|---|---|
| `cve` | `string` The CVE of the vulnerability. CVE cannot be empty and the combination of \<cve, classification\> should be unique across vulnerabilities for a VM. |
| `cvssV2Score` | `number` The CVSS V2 score of this vulnerability. CVSS V2 score is on a scale of 0 - 10 where 0 indicates low severity and 10 indicates high severity. |
| `cvssV3` | ``object (`https://docs.cloud.google.com/compute/docs/osconfig/rest/v1/projects.locations.instances.vulnerabilityReports#CVSSv3`)`` The full description of the CVSSv3 for this vulnerability from NVD. |
| `severity` | `string` Assigned severity/impact ranking from the distro. |
| `description` | `string` The note or description describing the vulnerability from the distro. |
| `references[]` | ``object (`https://docs.cloud.google.com/compute/docs/osconfig/rest/v1/projects.locations.instances.vulnerabilityReports#Reference`)`` Corresponds to the references attached to the `VulnerabilityDetails`. |

## CVSSv3

Common Vulnerability Scoring System version 3. For details, see <https://www.first.org/cvss/specification-document>

| JSON representation |
|---|
| ``` { "baseScore": number, "exploitabilityScore": number, "impactScore": number, "attackVector": enum (`https://docs.cloud.google.com/compute/docs/osconfig/rest/v1/projects.locations.instances.vulnerabilityReports#AttackVector`), "attackComplexity": enum (`https://docs.cloud.google.com/compute/docs/osconfig/rest/v1/projects.locations.instances.vulnerabilityReports#AttackComplexity`), "privilegesRequired": enum (`https://docs.cloud.google.com/compute/docs/osconfig/rest/v1/projects.locations.instances.vulnerabilityReports#PrivilegesRequired`), "userInteraction": enum (`https://docs.cloud.google.com/compute/docs/osconfig/rest/v1/projects.locations.instances.vulnerabilityReports#UserInteraction`), "scope": enum (`https://docs.cloud.google.com/compute/docs/osconfig/rest/v1/projects.locations.instances.vulnerabilityReports#Scope`), "confidentialityImpact": enum (`https://docs.cloud.google.com/compute/docs/osconfig/rest/v1/projects.locations.instances.vulnerabilityReports#Impact`), "integrityImpact": enum (`https://docs.cloud.google.com/compute/docs/osconfig/rest/v1/projects.locations.instances.vulnerabilityReports#Impact`), "availabilityImpact": enum (`https://docs.cloud.google.com/compute/docs/osconfig/rest/v1/projects.locations.instances.vulnerabilityReports#Impact`) } ``` |

| Fields ||
|---|---|
| `baseScore` | `number` The base score is a function of the base metric scores. <https://www.first.org/cvss/specification-document#Base-Metrics> |
| `exploitabilityScore` | `number` The Exploitability sub-score equation is derived from the Base Exploitability metrics. <https://www.first.org/cvss/specification-document#2-1-Exploitability-Metrics> |
| `impactScore` | `number` The Impact sub-score equation is derived from the Base Impact metrics. |
| `attackVector` | ``enum (`https://docs.cloud.google.com/compute/docs/osconfig/rest/v1/projects.locations.instances.vulnerabilityReports#AttackVector`)`` This metric reflects the context by which vulnerability exploitation is possible. |
| `attackComplexity` | ``enum (`https://docs.cloud.google.com/compute/docs/osconfig/rest/v1/projects.locations.instances.vulnerabilityReports#AttackComplexity`)`` This metric describes the conditions beyond the attacker's control that must exist in order to exploit the vulnerability. |
| `privilegesRequired` | ``enum (`https://docs.cloud.google.com/compute/docs/osconfig/rest/v1/projects.locations.instances.vulnerabilityReports#PrivilegesRequired`)`` This metric describes the level of privileges an attacker must possess before successfully exploiting the vulnerability. |
| `userInteraction` | ``enum (`https://docs.cloud.google.com/compute/docs/osconfig/rest/v1/projects.locations.instances.vulnerabilityReports#UserInteraction`)`` This metric captures the requirement for a human user, other than the attacker, to participate in the successful compromise of the vulnerable component. |
| `scope` | ``enum (`https://docs.cloud.google.com/compute/docs/osconfig/rest/v1/projects.locations.instances.vulnerabilityReports#Scope`)`` The Scope metric captures whether a vulnerability in one vulnerable component impacts resources in components beyond its security scope. |
| `confidentialityImpact` | ``enum (`https://docs.cloud.google.com/compute/docs/osconfig/rest/v1/projects.locations.instances.vulnerabilityReports#Impact`)`` This metric measures the impact to the confidentiality of the information resources managed by a software component due to a successfully exploited vulnerability. |
| `integrityImpact` | ``enum (`https://docs.cloud.google.com/compute/docs/osconfig/rest/v1/projects.locations.instances.vulnerabilityReports#Impact`)`` This metric measures the impact to integrity of a successfully exploited vulnerability. |
| `availabilityImpact` | ``enum (`https://docs.cloud.google.com/compute/docs/osconfig/rest/v1/projects.locations.instances.vulnerabilityReports#Impact`)`` This metric measures the impact to the availability of the impacted component resulting from a successfully exploited vulnerability. |

## AttackVector

This metric reflects the context by which vulnerability exploitation is possible.

| Enums ||
|---|---|
| `ATTACK_VECTOR_UNSPECIFIED` | Invalid value. |
| `ATTACK_VECTOR_NETWORK` | The vulnerable component is bound to the network stack and the set of possible attackers extends beyond the other options listed below, up to and including the entire Internet. |
| `ATTACK_VECTOR_ADJACENT` | The vulnerable component is bound to the network stack, but the attack is limited at the protocol level to a logically adjacent topology. |
| `ATTACK_VECTOR_LOCAL` | The vulnerable component is not bound to the network stack and the attacker's path is via read/write/execute capabilities. |
| `ATTACK_VECTOR_PHYSICAL` | The attack requires the attacker to physically touch or manipulate the vulnerable component. |

## AttackComplexity

This metric describes the conditions beyond the attacker's control that must exist in order to exploit the vulnerability.

| Enums ||
|---|---|
| `ATTACK_COMPLEXITY_UNSPECIFIED` | Invalid value. |
| `ATTACK_COMPLEXITY_LOW` | Specialized access conditions or extenuating circumstances do not exist. An attacker can expect repeatable success when attacking the vulnerable component. |
| `ATTACK_COMPLEXITY_HIGH` | A successful attack depends on conditions beyond the attacker's control. That is, a successful attack cannot be accomplished at will, but requires the attacker to invest in some measurable amount of effort in preparation or execution against the vulnerable component before a successful attack can be expected. |

## PrivilegesRequired

This metric describes the level of privileges an attacker must possess before successfully exploiting the vulnerability.

| Enums ||
|---|---|
| `PRIVILEGES_REQUIRED_UNSPECIFIED` | Invalid value. |
| `PRIVILEGES_REQUIRED_NONE` | The attacker is unauthorized prior to attack, and therefore does not require any access to settings or files of the vulnerable system to carry out an attack. |
| `PRIVILEGES_REQUIRED_LOW` | The attacker requires privileges that provide basic user capabilities that could normally affect only settings and files owned by a user. Alternatively, an attacker with Low privileges has the ability to access only non-sensitive resources. |
| `PRIVILEGES_REQUIRED_HIGH` | The attacker requires privileges that provide significant (e.g., administrative) control over the vulnerable component allowing access to component-wide settings and files. |

## UserInteraction

This metric captures the requirement for a human user, other than the attacker, to participate in the successful compromise of the vulnerable component.

| Enums ||
|---|---|
| `USER_INTERACTION_UNSPECIFIED` | Invalid value. |
| `USER_INTERACTION_NONE` | The vulnerable system can be exploited without interaction from any user. |
| `USER_INTERACTION_REQUIRED` | Successful exploitation of this vulnerability requires a user to take some action before the vulnerability can be exploited. |

## Scope

The Scope metric captures whether a vulnerability in one vulnerable component impacts resources in components beyond its security scope.

| Enums ||
|---|---|
| `SCOPE_UNSPECIFIED` | Invalid value. |
| `SCOPE_UNCHANGED` | An exploited vulnerability can only affect resources managed by the same security authority. |
| `SCOPE_CHANGED` | An exploited vulnerability can affect resources beyond the security scope managed by the security authority of the vulnerable component. |

## Impact

The Impact metrics capture the effects of a successfully exploited vulnerability on the component that suffers the worst outcome that is most directly and predictably associated with the attack.

| Enums ||
|---|---|
| `IMPACT_UNSPECIFIED` | Invalid value. |
| `IMPACT_HIGH` | High impact. |
| `IMPACT_LOW` | Low impact. |
| `IMPACT_NONE` | No impact. |

## Reference

A reference for this vulnerability.

| JSON representation |
|---|
| ``` { "url": string, "source": string } ``` |

| Fields ||
|---|---|
| `url` | `string` The url of the reference. |
| `source` | `string` The source of the reference e.g. NVD. |

## Item

OS inventory item that is affected by a vulnerability or fixed as a result of a vulnerability.

| JSON representation |
|---|
| ``` { "installedInventoryItemId": string, "availableInventoryItemId": string, "fixedCpeUri": string, "upstreamFix": string } ``` |

| Fields ||
|---|---|
| `installedInventoryItemId` | `string` Corresponds to the `INSTALLED_PACKAGE` inventory item on the VM. This field displays the inventory items affected by this vulnerability. If the vulnerability report was not updated after the VM inventory update, these values might not display in VM inventory. For some operating systems, this field might be empty. |
| `availableInventoryItemId` | `string` Corresponds to the `AVAILABLE_PACKAGE` inventory item on the VM. If the vulnerability report was not updated after the VM inventory update, these values might not display in VM inventory. If there is no available fix, the field is empty. The `inventory_item` value specifies the latest `SoftwarePackage` available to the VM that fixes the vulnerability. |
| `fixedCpeUri` | `string` The recommended [CPE URI](https://cpe.mitre.org/specification/) update that contains a fix for this vulnerability. |
| `upstreamFix` | `string` The upstream OS patch, packages or KB that fixes the vulnerability. |

## VulnerabilitySeverityLevel

Severity levels for vulnerabilities.

| Enums ||
|---|---|
| `VULNERABILITY_SEVERITY_LEVEL_UNSPECIFIED` | Default SeverityLevel. This value is unused. |
| `NONE` | Vulnerability has no severity level. |
| `MINIMAL` | Vulnerability severity level is minimal. This is level below the low severity level. |
| `LOW` | Vulnerability severity level is low. This is level below the medium severity level. |
| `MEDIUM` | Vulnerability severity level is medium. This is level below the high severity level. |
| `HIGH` | Vulnerability severity level is high. This is level below the critical severity level. |
| `CRITICAL` | Vulnerability severity level is critical. This is the highest severity level. |

| ## Methods ||
|---|---|
| ### `https://docs.cloud.google.com/compute/docs/osconfig/rest/v1/projects.locations.instances.vulnerabilityReports/get` | Gets the vulnerability report for the specified VM instance. |
| ### `https://docs.cloud.google.com/compute/docs/osconfig/rest/v1/projects.locations.instances.vulnerabilityReports/list` | List vulnerability reports for all VM instances in the specified zone. |