blob: 5e737e8ef8d432ad695c9d675b6a95cd0c38fbd6 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -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
75<h1><a href="websecurityscanner_v1alpha.html">Web Security Scanner API</a> . <a href="websecurityscanner_v1alpha.projects.html">projects</a> . <a href="websecurityscanner_v1alpha.projects.scanConfigs.html">scanConfigs</a> . <a href="websecurityscanner_v1alpha.projects.scanConfigs.scanRuns.html">scanRuns</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="websecurityscanner_v1alpha.projects.scanConfigs.scanRuns.crawledUrls.html">crawledUrls()</a></code>
79</p>
80<p class="firstline">Returns the crawledUrls Resource.</p>
81
82<p class="toc_element">
83 <code><a href="websecurityscanner_v1alpha.projects.scanConfigs.scanRuns.findingTypeStats.html">findingTypeStats()</a></code>
84</p>
85<p class="firstline">Returns the findingTypeStats Resource.</p>
86
87<p class="toc_element">
88 <code><a href="websecurityscanner_v1alpha.projects.scanConfigs.scanRuns.findings.html">findings()</a></code>
89</p>
90<p class="firstline">Returns the findings Resource.</p>
91
92<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070093 <code><a href="#close">close()</a></code></p>
94<p class="firstline">Close httplib2 connections.</p>
95<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070096 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
97<p class="firstline">Gets a ScanRun.</p>
98<p class="toc_element">
Yoshi Automation Botb6971b02020-11-26 17:16:03 -080099 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700100<p class="firstline">Lists ScanRuns under a given ScanConfig, in descending order of ScanRun stop time.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700101<p class="toc_element">
102 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
103<p class="firstline">Retrieves the next page of results.</p>
104<p class="toc_element">
105 <code><a href="#stop">stop(name, body=None, x__xgafv=None)</a></code></p>
106<p class="firstline">Stops a ScanRun. The stopped ScanRun is returned.</p>
107<h3>Method Details</h3>
108<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700109 <code class="details" id="close">close()</code>
110 <pre>Close httplib2 connections.</pre>
111</div>
112
113<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700114 <code class="details" id="get">get(name, x__xgafv=None)</code>
115 <pre>Gets a ScanRun.
116
117Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700118 name: string, Required. The resource name of the ScanRun to be returned. The name follows the format of &#x27;projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}&#x27;. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700119 x__xgafv: string, V1 error format.
120 Allowed values
121 1 - v1 error format
122 2 - v2 error format
123
124Returns:
125 An object of the form:
126
127 { # A ScanRun is a output-only resource representing an actual run of the scan.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800128 &quot;endTime&quot;: &quot;A String&quot;, # The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
129 &quot;executionState&quot;: &quot;A String&quot;, # The execution state of the ScanRun.
130 &quot;hasVulnerabilities&quot;: True or False, # Whether the scan run has found any vulnerabilities.
131 &quot;name&quot;: &quot;A String&quot;, # The resource name of the ScanRun. The name follows the format of &#x27;projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}&#x27;. The ScanRun IDs are generated by the system.
132 &quot;progressPercent&quot;: 42, # The percentage of total completion ranging from 0 to 100. If the scan is in queue, the value is 0. If the scan is running, the value ranges from 0 to 100. If the scan is finished, the value is 100.
133 &quot;resultState&quot;: &quot;A String&quot;, # The result state of the ScanRun. This field is only available after the execution state reaches &quot;FINISHED&quot;.
134 &quot;startTime&quot;: &quot;A String&quot;, # The time at which the ScanRun started.
135 &quot;urlsCrawledCount&quot;: &quot;A String&quot;, # The number of URLs crawled during this ScanRun. If the scan is in progress, the value represents the number of URLs crawled up to now.
136 &quot;urlsTestedCount&quot;: &quot;A String&quot;, # The number of URLs tested during this ScanRun. If the scan is in progress, the value represents the number of URLs tested up to now. The number of URLs tested is usually larger than the number URLS crawled because typically a crawled URL is tested with multiple test payloads.
137}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700138</div>
139
140<div class="method">
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800141 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700142 <pre>Lists ScanRuns under a given ScanConfig, in descending order of ScanRun stop time.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700143
144Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700145 parent: string, Required. The parent resource name, which should be a scan resource name in the format &#x27;projects/{projectId}/scanConfigs/{scanConfigId}&#x27;. (required)
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800146 pageSize: integer, The maximum number of ScanRuns to return, can be limited by server. If not specified or not positive, the implementation will select a reasonable value.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800147 pageToken: string, A token identifying a page of results to be returned. This should be a `next_page_token` value returned from a previous List request. If unspecified, the first page of results is returned.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700148 x__xgafv: string, V1 error format.
149 Allowed values
150 1 - v1 error format
151 2 - v2 error format
152
153Returns:
154 An object of the form:
155
156 { # Response for the `ListScanRuns` method.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800157 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token to retrieve the next page of results, or empty if there are no more results in the list.
158 &quot;scanRuns&quot;: [ # The list of ScanRuns returned.
159 { # A ScanRun is a output-only resource representing an actual run of the scan.
160 &quot;endTime&quot;: &quot;A String&quot;, # The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
161 &quot;executionState&quot;: &quot;A String&quot;, # The execution state of the ScanRun.
162 &quot;hasVulnerabilities&quot;: True or False, # Whether the scan run has found any vulnerabilities.
163 &quot;name&quot;: &quot;A String&quot;, # The resource name of the ScanRun. The name follows the format of &#x27;projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}&#x27;. The ScanRun IDs are generated by the system.
164 &quot;progressPercent&quot;: 42, # The percentage of total completion ranging from 0 to 100. If the scan is in queue, the value is 0. If the scan is running, the value ranges from 0 to 100. If the scan is finished, the value is 100.
165 &quot;resultState&quot;: &quot;A String&quot;, # The result state of the ScanRun. This field is only available after the execution state reaches &quot;FINISHED&quot;.
166 &quot;startTime&quot;: &quot;A String&quot;, # The time at which the ScanRun started.
167 &quot;urlsCrawledCount&quot;: &quot;A String&quot;, # The number of URLs crawled during this ScanRun. If the scan is in progress, the value represents the number of URLs crawled up to now.
168 &quot;urlsTestedCount&quot;: &quot;A String&quot;, # The number of URLs tested during this ScanRun. If the scan is in progress, the value represents the number of URLs tested up to now. The number of URLs tested is usually larger than the number URLS crawled because typically a crawled URL is tested with multiple test payloads.
169 },
170 ],
171}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700172</div>
173
174<div class="method">
175 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
176 <pre>Retrieves the next page of results.
177
178Args:
179 previous_request: The request for the previous page. (required)
180 previous_response: The response from the request for the previous page. (required)
181
182Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700183 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700184 page. Returns None if there are no more items in the collection.
185 </pre>
186</div>
187
188<div class="method">
189 <code class="details" id="stop">stop(name, body=None, x__xgafv=None)</code>
190 <pre>Stops a ScanRun. The stopped ScanRun is returned.
191
192Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700193 name: string, Required. The resource name of the ScanRun to be stopped. The name follows the format of &#x27;projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}&#x27;. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700194 body: object, The request body.
195 The object takes the form of:
196
197{ # Request for the `StopScanRun` method.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800198}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700199
200 x__xgafv: string, V1 error format.
201 Allowed values
202 1 - v1 error format
203 2 - v2 error format
204
205Returns:
206 An object of the form:
207
208 { # A ScanRun is a output-only resource representing an actual run of the scan.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800209 &quot;endTime&quot;: &quot;A String&quot;, # The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
210 &quot;executionState&quot;: &quot;A String&quot;, # The execution state of the ScanRun.
211 &quot;hasVulnerabilities&quot;: True or False, # Whether the scan run has found any vulnerabilities.
212 &quot;name&quot;: &quot;A String&quot;, # The resource name of the ScanRun. The name follows the format of &#x27;projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}&#x27;. The ScanRun IDs are generated by the system.
213 &quot;progressPercent&quot;: 42, # The percentage of total completion ranging from 0 to 100. If the scan is in queue, the value is 0. If the scan is running, the value ranges from 0 to 100. If the scan is finished, the value is 100.
214 &quot;resultState&quot;: &quot;A String&quot;, # The result state of the ScanRun. This field is only available after the execution state reaches &quot;FINISHED&quot;.
215 &quot;startTime&quot;: &quot;A String&quot;, # The time at which the ScanRun started.
216 &quot;urlsCrawledCount&quot;: &quot;A String&quot;, # The number of URLs crawled during this ScanRun. If the scan is in progress, the value represents the number of URLs crawled up to now.
217 &quot;urlsTestedCount&quot;: &quot;A String&quot;, # The number of URLs tested during this ScanRun. If the scan is in progress, the value represents the number of URLs tested up to now. The number of URLs tested is usually larger than the number URLS crawled because typically a crawled URL is tested with multiple test payloads.
218}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700219</div>
220
221</body></html>