blob: 1121bfd3f67102719a99fc874c6fad2baad572f7 [file] [edit]
<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="apigee_v1.html">Apigee API</a> . <a href="apigee_v1.organizations.html">organizations</a> . <a href="apigee_v1.organizations.environments.html">environments</a> . <a href="apigee_v1.organizations.environments.securityIncidents.html">securityIncidents</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="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">GetSecurityIncident gets the specified security incident. Returns NOT_FOUND if security incident is not present for the specified organization and environment.</p>
<p class="toc_element">
<code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">ListSecurityIncidents lists all the security incident associated with the environment.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</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="get">get(name, x__xgafv=None)</code>
<pre>GetSecurityIncident gets the specified security incident. Returns NOT_FOUND if security incident is not present for the specified organization and environment.
Args:
name: string, Required. Security incident in the following format: `organizations/{org}/environments/{environment}/securityIncidents/{incident}&#x27;. Example: organizations/testOrg/environments/testEnv/securityIncidents/1234-4567-890-111 (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Represents an SecurityIncident resource.
&quot;detectionTypes&quot;: [ # Output only. Detection types which are part of the incident. Examples: Flooder, OAuth Abuser, Static Content Scraper, Anomaly Detection.
&quot;A String&quot;,
],
&quot;displayName&quot;: &quot;A String&quot;, # Display name of the security incident.
&quot;firstDetectedTime&quot;: &quot;A String&quot;, # Output only. The time when events associated with the incident were first detected.
&quot;lastDetectedTime&quot;: &quot;A String&quot;, # Output only. The time when events associated with the incident were last detected.
&quot;name&quot;: &quot;A String&quot;, # Immutable. Name of the security incident resource. Format: organizations/{org}/environments/{environment}/securityIncidents/{incident} Example: organizations/apigee-org/environments/dev/securityIncidents/1234-5678-9101-1111
&quot;riskLevel&quot;: &quot;A String&quot;, # Output only. Risk level of the incident.
&quot;trafficCount&quot;: &quot;A String&quot;, # Total traffic detected as part of the incident.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>ListSecurityIncidents lists all the security incident associated with the environment.
Args:
parent: string, Required. For a specific organization, list of all the security incidents. Format: `organizations/{org}/environments/{environment}` (required)
filter: string, The filter expression to be used to get the list of security incidents, where filtering can be done on API Proxies. Example: filter = &quot;api_proxy = /&quot;, &quot;first_detected_time &gt;&quot;, &quot;last_detected_time &lt;&quot;
pageSize: integer, The maximum number of incidents to return. The service may return fewer than this value. If unspecified, at most 50 incidents will be returned.
pageToken: string, A page token, received from a previous `ListSecurityIncident` call. Provide this to retrieve the subsequent page.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response for ListSecurityIncidents.
&quot;nextPageToken&quot;: &quot;A String&quot;, # A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
&quot;securityIncidents&quot;: [ # List of security incidents in the organization
{ # Represents an SecurityIncident resource.
&quot;detectionTypes&quot;: [ # Output only. Detection types which are part of the incident. Examples: Flooder, OAuth Abuser, Static Content Scraper, Anomaly Detection.
&quot;A String&quot;,
],
&quot;displayName&quot;: &quot;A String&quot;, # Display name of the security incident.
&quot;firstDetectedTime&quot;: &quot;A String&quot;, # Output only. The time when events associated with the incident were first detected.
&quot;lastDetectedTime&quot;: &quot;A String&quot;, # Output only. The time when events associated with the incident were last detected.
&quot;name&quot;: &quot;A String&quot;, # Immutable. Name of the security incident resource. Format: organizations/{org}/environments/{environment}/securityIncidents/{incident} Example: organizations/apigee-org/environments/dev/securityIncidents/1234-5678-9101-1111
&quot;riskLevel&quot;: &quot;A String&quot;, # Output only. Risk level of the incident.
&quot;trafficCount&quot;: &quot;A String&quot;, # Total traffic detected as part of the incident.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call &#x27;execute()&#x27; on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>