blob: b5c82c025f864f0d49dfa61cbf4d9a7b497ed3b2 [file] [log] [blame]
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -07001<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070075<h1><a href="safebrowsing_v4.html">Safe Browsing API</a> . <a href="safebrowsing_v4.fullHashes.html">fullHashes</a></h1>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -070076<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070078 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070081 <code><a href="#find">find(body=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -070082<p class="firstline">Finds the full hashes that match the requested hash prefixes.</p>
83<h3>Method Details</h3>
84<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070085 <code class="details" id="close">close()</code>
86 <pre>Close httplib2 connections.</pre>
87</div>
88
89<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -070090 <code class="details" id="find">find(body=None, x__xgafv=None)</code>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -070091 <pre>Finds the full hashes that match the requested hash prefixes.
92
93Args:
Dan O'Mearadd494642020-05-01 07:42:23 -070094 body: object, The request body.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -070095 The object takes the form of:
96
97{ # Request to return full hashes matched by the provided hash prefixes.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -080098 &quot;clientStates&quot;: [ # The current client states for each of the client&#x27;s local threat lists.
99 &quot;A String&quot;,
100 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700101 &quot;apiClient&quot;: { # The client metadata associated with Safe Browsing API requests. # Client metadata associated with callers of higher-level APIs built on top of the client&#x27;s implementation.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700102 &quot;clientVersion&quot;: &quot;A String&quot;, # The version of the client implementation.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800103 &quot;clientId&quot;: &quot;A String&quot;, # A client ID that (hopefully) uniquely identifies the client implementation of the Safe Browsing API.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700104 },
105 &quot;threatInfo&quot;: { # The information regarding one or more threats that a client submits when checking for matches in threat lists. # The lists and hashes to be checked.
Bu Sun Kim65020912020-05-20 12:08:20 -0700106 &quot;threatTypes&quot;: [ # The threat types to be checked.
107 &quot;A String&quot;,
108 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800109 &quot;threatEntries&quot;: [ # The threat entries to be checked.
110 { # An individual threat; for example, a malicious URL or its hash representation. Only one of these fields should be set.
111 &quot;url&quot;: &quot;A String&quot;, # A URL.
112 &quot;hash&quot;: &quot;A String&quot;, # A hash prefix, consisting of the most significant 4-32 bytes of a SHA256 hash. This field is in binary format. For JSON requests, hashes are base64-encoded.
113 &quot;digest&quot;: &quot;A String&quot;, # The digest of an executable in SHA256 format. The API supports both binary and hex digests. For JSON requests, digests are base64-encoded.
114 },
115 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700116 &quot;threatEntryTypes&quot;: [ # The entry types to be checked.
117 &quot;A String&quot;,
118 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700119 &quot;platformTypes&quot;: [ # The platform types to be checked.
120 &quot;A String&quot;,
121 ],
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700122 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700123 &quot;client&quot;: { # The client metadata associated with Safe Browsing API requests. # The client metadata.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700124 &quot;clientVersion&quot;: &quot;A String&quot;, # The version of the client implementation.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800125 &quot;clientId&quot;: &quot;A String&quot;, # A client ID that (hopefully) uniquely identifies the client implementation of the Safe Browsing API.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700126 },
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700127 }
128
129 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400130 Allowed values
131 1 - v1 error format
132 2 - v2 error format
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700133
134Returns:
135 An object of the form:
136
137 {
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800138 &quot;minimumWaitDuration&quot;: &quot;A String&quot;, # The minimum duration the client must wait before issuing any find hashes request. If this field is not set, clients can issue a request as soon as they want.
Bu Sun Kim65020912020-05-20 12:08:20 -0700139 &quot;matches&quot;: [ # The full hashes that matched the requested prefixes.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700140 { # A match when checking a threat entry in the Safe Browsing threat lists.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800141 &quot;threatEntryType&quot;: &quot;A String&quot;, # The threat entry type matching this threat.
142 &quot;threat&quot;: { # An individual threat; for example, a malicious URL or its hash representation. Only one of these fields should be set. # The threat matching this threat.
143 &quot;url&quot;: &quot;A String&quot;, # A URL.
144 &quot;hash&quot;: &quot;A String&quot;, # A hash prefix, consisting of the most significant 4-32 bytes of a SHA256 hash. This field is in binary format. For JSON requests, hashes are base64-encoded.
145 &quot;digest&quot;: &quot;A String&quot;, # The digest of an executable in SHA256 format. The API supports both binary and hex digests. For JSON requests, digests are base64-encoded.
146 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700147 &quot;threatType&quot;: &quot;A String&quot;, # The threat type matching this threat.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700148 &quot;threatEntryMetadata&quot;: { # The metadata associated with a specific threat entry. The client is expected to know the metadata key/value pairs associated with each threat type. # Optional metadata associated with this threat.
Bu Sun Kim65020912020-05-20 12:08:20 -0700149 &quot;entries&quot;: [ # The metadata entries.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700150 { # A single metadata entry.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700151 &quot;value&quot;: &quot;A String&quot;, # The metadata entry value. For JSON requests, the value is base64-encoded.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800152 &quot;key&quot;: &quot;A String&quot;, # The metadata entry key. For JSON requests, the key is base64-encoded.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700153 },
154 ],
155 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700156 &quot;platformType&quot;: &quot;A String&quot;, # The platform type matching this threat.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800157 &quot;cacheDuration&quot;: &quot;A String&quot;, # The cache lifetime for the returned match. Clients must not cache this response for more than this duration to avoid false positives.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700158 },
159 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700160 &quot;negativeCacheDuration&quot;: &quot;A String&quot;, # For requested entities that did not match the threat list, how long to cache the response.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700161 }</pre>
162</div>
163
164</body></html>