Method: watchlists.list

Full name: projects.locations.instances.watchlists.list

Lists all watchlists for the given instance.

HTTP request

GET https://chronicle.googleapis.com/v1alpha/{parent}/watchlists

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 ListWatchlists call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListWatchlists 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: - watchlist_user_preferences.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:

JSON representation 
{
  "watchlists": [
    {
      object (Watchlist)
    }
  ],
  "next_page_token": string
}
Fields
watchlists[]

object (Watchlist)

Optional. The watchlists from the specified instance.
next_page_token

string

Optional. A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • chronicle.watchlists.list

For more information, see the IAM documentation.