Full name: projects.locations.instances.watchlists.list
Lists all watchlists for the given instance.
HTTP request
Path parameters
Parameters
parent
string
Required. The parent, which owns this collection of watchlists. Format: projects/{project}/locations/{location}/instances/{instance}
Query parameters
Parameters
pageSize
integer
Optional. The maximum number of watchlists to return. The service may return fewer than this value. If unspecified, at most 200 watchlists will be returned. The maximum value is 200; values above 200 will be coerced to 200.
pageToken
string
Optional. A page token, received from a previous watchlists.list call. Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to watchlists.list must match the call that provided the page token.
filter
string
Optional. Which watchlist to return in aip.dev/160 form. Currently, only the following filters are supported: - watchlistUserPreferences.pinned=true - has_entity([ENTITY_INDICATOR],[ENTITY_TYPE]) - has_entity([ENTITY_INDICATOR],[ENTITY_TYPE],[NAMESPACE])
Request body
The request body must be empty.
Response body
Response message for listing watchlists.
If successful, the response body contains data with the following structure:
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-25 UTC."],[[["\u003cp\u003eThis endpoint retrieves a list of watchlists associated with a specific instance within a project, location, and instance.\u003c/p\u003e\n"],["\u003cp\u003eThe request is made using an HTTP GET method, with the \u003ccode\u003eparent\u003c/code\u003e path parameter specifying the location of the watchlists.\u003c/p\u003e\n"],["\u003cp\u003eOptional query parameters like \u003ccode\u003epageSize\u003c/code\u003e, \u003ccode\u003epageToken\u003c/code\u003e, and \u003ccode\u003efilter\u003c/code\u003e allow for pagination and filtering of the watchlist results.\u003c/p\u003e\n"],["\u003cp\u003eThe request body must be empty, and the successful response includes an array of \u003ccode\u003ewatchlists\u003c/code\u003e and a \u003ccode\u003enext_page_token\u003c/code\u003e for further pagination.\u003c/p\u003e\n"],["\u003cp\u003eTo use this API, you need the \u003ccode\u003echronicle.watchlists.list\u003c/code\u003e IAM permission and the \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e OAuth scope.\u003c/p\u003e\n"]]],[],null,[]]