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."],[],[],null,["# Method: watchlists.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListWatchlistsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [IAM Permissions](#body.aspect_1)\n- [Try it!](#try-it)\n\n**Full name**: projects.locations.instances.watchlists.list\n\nLists all watchlists for the given instance.\n\n### HTTP request\n\nChoose a location: \nafrica-south1 asia-northeast1 asia-south1 asia-southeast1 asia-southeast2 australia-southeast1 europe-west12 europe-west2 europe-west3 europe-west6 europe-west9 me-central1 me-central2 me-west1 northamerica-northeast2 southamerica-east1 us eu \n\n\u003cbr /\u003e\n\n### Path parameters\n\n### Query parameters\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse message for listing watchlists.\n\nIf successful, the response body contains data with the following structure:\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authentication Overview](/docs/authentication#authorization-gcp).\n\n### IAM Permissions\n\nRequires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource:\n\n- `chronicle.watchlists.list`\n\nFor more information, see the [IAM documentation](https://cloud.google.com/iam/docs)."]]