- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- Try it!
Lists an organization or source's findings.
To list across all sources provide a -
as the source id. Example: /v1beta1/organizations/{organization_id}/sources/-/findings
HTTP request
The URLs use gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
parent |
Required. Name of the source the findings belong to. Its format is "organizations/[organization_id]/sources/[source_id]". To list across all sources provide a source_id of |
Query parameters
Parameters | |
---|---|
filter |
Expression that defines the filter to apply across findings. The expression is a list of one or more restrictions combined via logical operators Restrictions have the form
The supported operators are:
The supported value types are:
For example, |
orderBy |
Expression that defines what fields and order to use for sorting. The string value should follow SQL syntax: comma separated list of fields. For example: "name,resourceProperties.a_property". The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be appended to the field name. For example: "name desc,sourceProperties.a_property". Redundant space characters in the syntax are insignificant. "name desc,sourceProperties.a_property" and " name desc , sourceProperties.a_property " are equivalent. |
readTime |
Time used as a reference point when filtering findings. The filter is limited to findings existing at the supplied time and their values are those at that specific time. Absence of this field will default to the API's version of NOW. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
fieldMask |
Optional. A field mask to specify the Finding fields to be listed in the response. An empty field mask will list all fields. |
pageToken |
The value returned by the last |
pageSize |
The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000. |
Request body
The request body must be empty.
Response body
Response message for listing findings.
If successful, the response body contains data with the following structure:
JSON representation |
---|
{
"findings": [
{
object ( |
Fields | |
---|---|
findings[] |
Findings matching the list request. |
readTime |
Time used for executing the list request. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
nextPageToken |
Token to retrieve the next page of results, or empty if there are no more results. |
totalSize |
The total number of findings matching the query. |
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.