Method: threatLists.list
Stay organized with collections
Save and categorize content based on your preferences.
Lists the Safe Browsing threat lists available for download.
HTTP request
GET https://safebrowsing.googleapis.com/v4/threatLists
The URL uses gRPC Transcoding syntax.
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
| Fields |
threatLists[] |
object (ThreatListDescriptor)
The lists available for download by the client.
|
ThreatListDescriptor
Describes an individual threat list. A list is defined by three parameters: the type of threat posed, the type of platform targeted by the threat, and the type of entries in the list.
| Fields |
threatType |
enum (ThreatType)
The threat type posed by the list's entries.
|
platformType |
enum (PlatformType)
The platform type targeted by the list's entries.
|
threatEntryType |
enum (ThreatEntryType)
The entry types contained in the list.
|
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\u003eThis API lists the Safe Browsing threat lists available for download.\u003c/p\u003e\n"],["\u003cp\u003eIt uses a GET request to \u003ccode\u003ehttps://safebrowsing.googleapis.com/v4/threatLists\u003c/code\u003e with an empty request body.\u003c/p\u003e\n"],["\u003cp\u003eThe response provides a list of \u003ccode\u003eThreatListDescriptor\u003c/code\u003e objects, each describing a threat list with its type, platform, and entry type.\u003c/p\u003e\n"],["\u003cp\u003eEach \u003ccode\u003eThreatListDescriptor\u003c/code\u003e helps identify the specific threats, platforms affected, and the kind of entries within each list.\u003c/p\u003e\n"]]],["This document outlines how to retrieve a list of available Safe Browsing threat lists. A `GET` request to `https://safebrowsing.googleapis.com/v4/threatLists` is used, with an empty request body. The successful response contains a JSON array of `threatLists`, each described by a `ThreatListDescriptor` object. This descriptor specifies the `threatType`, `platformType`, and `threatEntryType` of each list, defining the characteristics of the threats it contains.\n"],null,["# Method: threatLists.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListThreatListsResponse.SCHEMA_REPRESENTATION)\n- [ThreatListDescriptor](#ThreatListDescriptor)\n - [JSON representation](#ThreatListDescriptor.SCHEMA_REPRESENTATION)\n\nLists the Safe Browsing threat lists available for download.\n\n### HTTP request\n\n`GET https://safebrowsing.googleapis.com/v4/threatLists`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|--------------------------------------------------------------------------------------------------------------------|\n| ``` { \"threatLists\": [ { object (/safe-browsing/reference/rest/v4/threatLists/list#ThreatListDescriptor) } ] } ``` |\n\n| Fields ||\n|-----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `threatLists[]` | `object (`[ThreatListDescriptor](/safe-browsing/reference/rest/v4/threatLists/list#ThreatListDescriptor)`)` The lists available for download by the client. |\n\nThreatListDescriptor\n--------------------\n\nDescribes an individual threat list. A list is defined by three parameters: the type of threat posed, the type of platform targeted by the threat, and the type of entries in the list.\n\n| JSON representation |\n|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"threatType\": enum (/safe-browsing/reference/rest/v4/ThreatType), \"platformType\": enum (/safe-browsing/reference/rest/v4/PlatformType), \"threatEntryType\": enum (/safe-browsing/reference/rest/v4/ThreatEntryType) } ``` |\n\n| Fields ||\n|-------------------|----------------------------------------------------------------------------------------------------------------------------|\n| `threatType` | `enum (`[ThreatType](/safe-browsing/reference/rest/v4/ThreatType)`)` The threat type posed by the list's entries. |\n| `platformType` | `enum (`[PlatformType](/safe-browsing/reference/rest/v4/PlatformType)`)` The platform type targeted by the list's entries. |\n| `threatEntryType` | `enum (`[ThreatEntryType](/safe-browsing/reference/rest/v4/ThreatEntryType)`)` The entry types contained in the list. |"]]
