blob: aa4fcab29deb8b2f045cc7af12ed792d6a08b615 [file] [log] [blame]
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="webrisk_v1.html">Web Risk API</a> . <a href="webrisk_v1.uris.html">uris</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#search">search(threatTypes=None, uri=None, x__xgafv=None)</a></code></p>
<p class="firstline">This method is used to check whether a URI is on a given threatList. Multiple threatLists may be searched in a single query. The response will list all requested threatLists the URI was found to match. If the URI is not found on any of the requested ThreatList an empty response will be returned.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="search">search(threatTypes=None, uri=None, x__xgafv=None)</code>
<pre>This method is used to check whether a URI is on a given threatList. Multiple threatLists may be searched in a single query. The response will list all requested threatLists the URI was found to match. If the URI is not found on any of the requested ThreatList an empty response will be returned.
Args:
threatTypes: string, Required. The ThreatLists to search in. Multiple ThreatLists may be specified. (repeated)
Allowed values
THREAT_TYPE_UNSPECIFIED - No entries should match this threat type. This threat type is unused.
MALWARE - Malware targeting any platform.
SOCIAL_ENGINEERING - Social engineering targeting any platform.
UNWANTED_SOFTWARE - Unwanted software targeting any platform.
uri: string, Required. The URI to be checked for matches.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
&quot;threat&quot;: { # Contains threat information on a matching uri. # The threat list matches. This may be empty if the URI is on no list.
&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.
&quot;threatTypes&quot;: [ # The ThreatList this threat belongs to.
&quot;A String&quot;,
],
},
}</pre>
</div>
</body></html>