Method: projects.notes.list

Lists notes for the specified project.

HTTP request


GET https://containeranalysis.googleapis.com/v1/{parent=projects/*}/notes

The URLs usegRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The name of the project to list notes for in the form ofprojects/[PROJECT_ID].

Query parameters

Parameters
filter

string

The filter expression.

pageSize

integer

Number of notes to return in the list. Must be positive. Max allowed page size is 1000. If not specified, page size defaults to 20.

pageToken

string

Token to provide to skip to a particular spot in the list.

returnPartialSuccess

boolean

If set, the request will return all reachable Notes and report all unreachable regions in theunreachable field in the response.

Only applicable for requests in the global region.

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance ofListNotesResponse.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see theAuthentication Overview.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2026-01-09 UTC.