Method: projects.scanConfigs.scanRuns.findings.list

List Findings under a given ScanRun.

HTTP request

GET https://websecurityscanner.googleapis.com/v1alpha/{parent=projects/*/scanConfigs/*/scanRuns/*}/findings

The URL uses Google API HTTP annotation syntax.

Path parameters

Parameters
parent

string

Required. The parent resource name, which should be a scan run resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.

Authorization requires the following Google IAM permission on the specified resource parent:

  • cloudsecurityscanner.results.list

Query parameters

Parameters
filter

string

The filter expression. The expression must be in the format: . Supported field: 'findingType'. Supported operator: '='.

pageToken

string

A token identifying a page of results to be returned. This should be a nextPageToken value returned from a previous List request. If unspecified, the first page of results is returned.

pageSize

number

The maximum number of Findings to return, can be limited by server. If not specified or not positive, the implementation will select a reasonable value.

Request body

The request body must be empty.

Response body

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

Response for the findings.list method.

JSON representation
{
  "findings": [
    {
      object(Finding)
    }
  ],
  "nextPageToken": string
}
Fields
findings[]

object(Finding)

The list of Findings returned.

nextPageToken

string

Token to retrieve the next page of results, or empty if there are no more results in the list.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Auth Guide.

Was this page helpful? Let us know how we did:

Send feedback about...

Cloud Security Scanner