Method: hashLists.list
Stay organized with collections
Save and categorize content based on your preferences.
List hash lists.
In the V5 API, Google will never remove a hash list that has ever been returned by this method. This enables clients to skip using this method and simply hard-code all hash lists they need.
This is a standard List method as defined by https://google.aip.dev/132 and the HTTP method is GET.
HTTP request
GET https://safebrowsing.googleapis.com/v5alpha1/hashLists
The URL uses gRPC Transcoding syntax.
Query parameters
| Parameters |
pageSize |
integer
The maximum number of hash lists to return. The service may return fewer than this value. If unspecified, the server will choose a page size, which may be larger than the number of hash lists so that pagination is not necessary.
|
pageToken |
string
A page token, received from a previous hashLists.list call. Provide this to retrieve the subsequent page.
|
Request body
The request body must be empty.
Response body
The response containing metadata about hash lists.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"hashLists": [
{
object (HashList)
}
],
"nextPageToken": string
} |
| Fields |
hashLists[] |
object (HashList)
The hash lists in an arbitrary order. Only metadata about the hash lists will be included, not the contents.
|
nextPageToken |
string
A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.
|
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 2024-09-18 UTC.
[null,null,["Last updated 2024-09-18 UTC."],[[["\u003cp\u003eRetrieves a list of available hash lists with metadata, excluding their contents.\u003c/p\u003e\n"],["\u003cp\u003eAllows for pagination to retrieve large sets of hash lists using \u003ccode\u003epageSize\u003c/code\u003e and \u003ccode\u003epageToken\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eGoogle guarantees that hash lists once returned will never be removed, enabling client-side hardcoding.\u003c/p\u003e\n"],["\u003cp\u003eEmploys standard List method with a GET request to \u003ccode\u003ehttps://safebrowsing.googleapis.com/v5alpha1/hashLists\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eResponse includes details about each hash list and a token for retrieving subsequent pages if available.\u003c/p\u003e\n"]]],["This document details the process for retrieving metadata about hash lists using the V5 API's `hashLists.list` method. It uses an HTTP GET request to `https://safebrowsing.googleapis.com/v5alpha1/hashLists`. Optional query parameters include `pageSize` to limit results and `pageToken` for pagination. The request body must be empty. The response body includes an array of `hashLists` and an optional `nextPageToken` for subsequent pages. The API never removes returned hash lists.\n"],null,["# Method: hashLists.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListHashListsResponse.SCHEMA_REPRESENTATION)\n\nList hash lists.\n\nIn the V5 API, Google will never remove a hash list that has ever been returned by this method. This enables clients to skip using this method and simply hard-code all hash lists they need.\n\nThis is a standard List method as defined by \u003chttps://google.aip.dev/132\u003e and the HTTP method is GET.\n\n### HTTP request\n\n`GET https://safebrowsing.googleapis.com/v5alpha1/hashLists`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Query parameters\n\n| Parameters ||\n|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` The maximum number of hash lists to return. The service may return fewer than this value. If unspecified, the server will choose a page size, which may be larger than the number of hash lists so that pagination is not necessary. |\n| `pageToken` | `string` A page token, received from a previous `hashLists.list` call. Provide this to retrieve the subsequent page. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nThe response containing metadata about hash lists.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"hashLists\": [ { object (/safe-browsing/reference/rest/v5alpha1/hashList#HashList) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `hashLists[]` | `object (`[HashList](/safe-browsing/reference/rest/v5alpha1/hashList#HashList)`)` The hash lists in an arbitrary order. Only metadata about the hash lists will be included, not the contents. |\n| `nextPageToken` | `string` A token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted, there are no subsequent pages. |"]]
