Method: threatMatches.find
Stay organized with collections
Save and categorize content based on your preferences.
Finds the threat entries that match the Safe Browsing lists.
HTTP request
POST https://safebrowsing.googleapis.com/v4/threatMatches:find
The URL uses gRPC Transcoding
syntax.
Request body
The request body contains data with the following structure:
| Fields |
client
|
object ( ClientInfo
)
The client metadata.
|
threatInfo
|
object ( ThreatInfo
)
The lists and entries to be checked for matches.
|
Response body
If successful, the response body contains data with the following structure:
| Fields |
matches[]
|
object ( ThreatMatch
)
The threat list matches.
|
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.
[[["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 2024-09-18 UTC."],[[["\u003cp\u003eThis API endpoint allows you to find threat entries that match Safe Browsing lists using an HTTP POST request.\u003c/p\u003e\n"],["\u003cp\u003eThe request body requires client metadata and information about the threats to be checked, sent as a JSON object.\u003c/p\u003e\n"],["\u003cp\u003eA successful response returns a JSON object containing a list of any matches found in the Safe Browsing lists.\u003c/p\u003e\n"],["\u003cp\u003eYou can find details about the request and response structures by referencing \u003ccode\u003eClientInfo\u003c/code\u003e, \u003ccode\u003eThreatInfo\u003c/code\u003e, and \u003ccode\u003eThreatMatch\u003c/code\u003e in the provided documentation links.\u003c/p\u003e\n"]]],["The core function is to find threat entries matching Safe Browsing lists. This is achieved via a `POST` request to `https://safebrowsing.googleapis.com/v4/threatMatches:find`. The request body requires a JSON object with `client` and `threatInfo` fields. The successful response body returns a JSON object containing an array `matches[]`, which contains any identified threat matches. The provided links lead to other pages that explain further information.\n"],null,["# Method: threatMatches.find\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n - [JSON representation](#body.FindThreatMatchesResponse.SCHEMA_REPRESENTATION)\n\nFinds the threat entries that match the Safe Browsing lists.\n\n### HTTP request\n\n`POST https://safebrowsing.googleapis.com/v4/threatMatches:find`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|--------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"client\": { object (/safe-browsing/reference/rest/v4/ClientInfo) }, \"threatInfo\": { object (/safe-browsing/reference/rest/v4/ThreatInfo) } } ``` |\n\n| Fields ||\n|--------------|-------------------------------------------------------------------------------------------------------------------------|\n| `client` | `object (`[ClientInfo](/safe-browsing/reference/rest/v4/ClientInfo)`)` The client metadata. |\n| `threatInfo` | `object (`[ThreatInfo](/safe-browsing/reference/rest/v4/ThreatInfo)`)` The lists and entries to be checked for matches. |\n\n### Response body\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|--------------------------------------------------------------------------------------|\n| ``` { \"matches\": [ { object (/safe-browsing/reference/rest/v4/ThreatMatch) } ] } ``` |\n\n| Fields ||\n|-------------|---------------------------------------------------------------------------------------------------|\n| `matches[]` | `object (`[ThreatMatch](/safe-browsing/reference/rest/v4/ThreatMatch)`)` The threat list matches. |"]]
