blob: afba40aee08a777279eff8db2574128cae6ab700 [file] [log] [blame]
Anthonios Partheniou10f4b672021-04-13 14:47:53 -04001<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
75<h1><a href="webrisk_v1.html">Web Risk API</a> . <a href="webrisk_v1.hashes.html">hashes</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
81 <code><a href="#search">search(hashPrefix=None, threatTypes=None, x__xgafv=None)</a></code></p>
82<p class="firstline">Gets the full hashes that match the requested hash prefix. This is used after a hash prefix is looked up in a threatList and there is a match. The client side threatList only holds partial hashes so the client must query this method to determine if there is a full hash match of a threat.</p>
83<h3>Method Details</h3>
84<div class="method">
85 <code class="details" id="close">close()</code>
86 <pre>Close httplib2 connections.</pre>
87</div>
88
89<div class="method">
90 <code class="details" id="search">search(hashPrefix=None, threatTypes=None, x__xgafv=None)</code>
91 <pre>Gets the full hashes that match the requested hash prefix. This is used after a hash prefix is looked up in a threatList and there is a match. The client side threatList only holds partial hashes so the client must query this method to determine if there is a full hash match of a threat.
92
93Args:
94 hashPrefix: string, A hash prefix, consisting of the most significant 4-32 bytes of a SHA256 hash. For JSON requests, this field is base64-encoded. Note that if this parameter is provided by a URI, it must be encoded using the web safe base64 variant (RFC 4648).
95 threatTypes: string, Required. The ThreatLists to search in. Multiple ThreatLists may be specified. (repeated)
96 Allowed values
97 THREAT_TYPE_UNSPECIFIED - No entries should match this threat type. This threat type is unused.
98 MALWARE - Malware targeting any platform.
99 SOCIAL_ENGINEERING - Social engineering targeting any platform.
100 UNWANTED_SOFTWARE - Unwanted software targeting any platform.
101 x__xgafv: string, V1 error format.
102 Allowed values
103 1 - v1 error format
104 2 - v2 error format
105
106Returns:
107 An object of the form:
108
109 {
110 &quot;negativeExpireTime&quot;: &quot;A String&quot;, # For requested entities that did not match the threat list, how long to cache the response until.
111 &quot;threats&quot;: [ # The full hashes that matched the requested prefixes. The hash will be populated in the key.
112 { # Contains threat information on a matching hash.
113 &quot;expireTime&quot;: &quot;A String&quot;, # The cache lifetime for the returned match. Clients must not cache this response past this timestamp to avoid false positives.
114 &quot;hash&quot;: &quot;A String&quot;, # A 32 byte SHA256 hash. This field is in binary format. For JSON requests, hashes are base64-encoded.
115 &quot;threatTypes&quot;: [ # The ThreatList this threat belongs to. This must contain at least one entry.
116 &quot;A String&quot;,
117 ],
118 },
119 ],
120}</pre>
121</div>
122
123</body></html>