Method: projects.locations.instances.vulnerabilityReports.list

List vulnerability reports for all VM instances in the specified zone.

HTTP request

GET https://osconfig.googleapis.com/v1/{parent=projects/*/locations/*/instances/*}/vulnerabilityReports

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent resource name.

Format: projects/{project}/locations/{location}/instances/-

For {project}, either project-number or project-id can be provided.

Query parameters

Parameters
pageSize

integer

The maximum number of results to return.

pageToken

string

A pagination token returned from a previous call to vulnerabilityReports.list that indicates where this listing should continue from.

filter

string

This field supports filtering by the severity level for the vulnerability. For a list of severity levels, see Severity levels for vulnerabilities.

The filter field follows the rules described in the AIP-160 guidelines as follows:

  • Filter for a specific severity type: you can list reports that contain vulnerabilities that are classified as medium by specifying vulnerabilities.details.severity:MEDIUM.

  • Filter for a range of severities : you can list reports that have vulnerabilities that are classified as critical or high by specifying vulnerabilities.details.severity:HIGH OR vulnerabilities.details.severity:CRITICAL

Request body

The request body must be empty.

Response body

A response message for listing vulnerability reports for all VM instances in the specified location.

If successful, the response body contains data with the following structure:

JSON representation
{
  "vulnerabilityReports": [
    {
      object (VulnerabilityReport)
    }
  ],
  "nextPageToken": string
}
Fields
vulnerabilityReports[]

object (VulnerabilityReport)

List of vulnerabilityReport objects.

nextPageToken

string

The pagination token to retrieve the next page of vulnerabilityReports object.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • osconfig.vulnerabilityReports.list

For more information, see the IAM documentation.