Method: hashList.get

  • Get the latest contents of a hash list, which can be a threat list or the Global Cache, using a standard GET method.

  • The name path parameter specifies the hash list to retrieve.

  • Provide the version query parameter to indicate the client's current hash list version or leave it empty for the initial fetch.

  • Optionally, specify the desired hash prefix length using the desiredHashLength query parameter and set size constraints with the sizeConstraints parameter.

  • The response body will contain the requested HashList data.

Get the latest contents of a hash list. A hash list may either by a threat list or a non-threat list such as the Global Cache.

This is a standard Get method as defined by https://google.aip.dev/131 and the HTTP method is also GET.

HTTP request

GET https://safebrowsing.googleapis.com/v5alpha1/hashList/{name}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The name of this particular hash list. It may be a threat list, or it may be the Global Cache.

Query parameters

Parameters
version

string (bytes format)

The version of the hash list that the client already has. If this is the first time the client is fetching the hash list, this field MUST be left empty. Otherwise, the client SHOULD supply the version previously received from the server. The client MUST NOT manipulate those bytes.

What's new in V5: in V4 of the API, this was called states; it is now renamed to version for clarity.

A base64-encoded string.
sizeConstraints

object (SizeConstraints)

The size constraints on the list. If omitted, there are no constraints. Constraints are recommended on all devices with limited processing power, bandwidth, or storage.

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of HashList.