Method: hashList.get
Stay organized with collections
Save and categorize content based on your preferences.
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.
|
desiredHashLength
(deprecated) |
enum (HashLength)
The desired hash prefix length of the returned hashes in bytes. The server will then return all hash prefixes in this specified length. Different hash lists have different requirements on the acceptable values of desiredHashLength field. This can be found in the supportedHashLengths field in HashListMetadata. If desiredHashLength does not specify a value within supportedHashLengths, an error will be returned.
|
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.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-05 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-03-05 UTC."],[[["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."]]],["This document details retrieving a hash list (threat or non-threat) using a `GET` request. The URL is structured as `https://safebrowsing.googleapis.com/v5alpha1/hashList/{name}`, with `name` being a required path parameter. Optional query parameters include `version` (client's current list version), `desiredHashLength` (hash prefix length), and `sizeConstraints` (list size limits). The request body is empty, and a successful response returns a `HashList` instance.\n"]]
