1<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_v1beta.html">Web Security Scanner API</a> . <a href="websecurityscanner_v1beta.projects.html">projects</a> . <a href="websecurityscanner_v1beta.projects.scanConfigs.html">scanConfigs</a> . <a href="websecurityscanner_v1beta.projects.scanConfigs.scanRuns.html">scanRuns</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="websecurityscanner_v1beta.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_v1beta.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_v1beta.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"> 93 <code><a href="#close">close()</a></code></p> 94<p class="firstline">Close httplib2 connections.</p> 95<p class="toc_element"> 96 <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"> 99 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 100<p class="firstline">Lists ScanRuns under a given ScanConfig, in descending order of ScanRun stop time.</p> 101<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"> 109 <code class="details" id="close">close()</code> 110 <pre>Close httplib2 connections.</pre> 111</div> 112 113<div class="method"> 114 <code class="details" id="get">get(name, x__xgafv=None)</code> 115 <pre>Gets a ScanRun. 116 117Args: 118 name: string, Required. The resource name of the ScanRun to be returned. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. (required) 119 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. Next id: 12 128 "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user. 129 "errorTrace": { # Output only. Defines an error trace message for a ScanRun. # If result_state is an ERROR, this field provides the primary reason for scan's termination and more details, if such are available. 130 "code": "A String", # Indicates the error reason code. 131 "mostCommonHttpErrorCode": 42, # If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most common HTTP error code, if such is available. For example, if this code is 404, the scan has encountered too many NOT_FOUND responses. 132 "scanConfigError": { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig APIs when scan configuration validation fails. It is also reported as part of a ScanRunErrorTrace message if scan validation fails due to a scan configuration error. # If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error message encountered during scan configuration validation that is performed before each scan run. 133 "code": "A String", # Indicates the reason code for a configuration failure. 134 "fieldName": "A String", # Indicates the full name of the ScanConfig field that triggers this error, for example "scan_config.max_qps". This field is provided for troubleshooting purposes only and its actual value can change in the future. 135 }, 136 }, 137 "executionState": "A String", # The execution state of the ScanRun. 138 "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities. 139 "name": "A String", # The resource name of the ScanRun. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. The ScanRun IDs are generated by the system. 140 "progressPercent": 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. 141 "resultState": "A String", # The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED". 142 "startTime": "A String", # The time at which the ScanRun started. 143 "urlsCrawledCount": "A String", # 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. 144 "urlsTestedCount": "A String", # 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. 145 "warningTraces": [ # A list of warnings, if such are encountered during this scan run. 146 { # Output only. Defines a warning trace message for ScanRun. Warning traces provide customers with useful information that helps make the scanning process more effective. 147 "code": "A String", # Indicates the warning code. 148 }, 149 ], 150}</pre> 151</div> 152 153<div class="method"> 154 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> 155 <pre>Lists ScanRuns under a given ScanConfig, in descending order of ScanRun stop time. 156 157Args: 158 parent: string, Required. The parent resource name, which should be a scan resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}'. (required) 159 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. 160 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. 161 x__xgafv: string, V1 error format. 162 Allowed values 163 1 - v1 error format 164 2 - v2 error format 165 166Returns: 167 An object of the form: 168 169 { # Response for the `ListScanRuns` method. 170 "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list. 171 "scanRuns": [ # The list of ScanRuns returned. 172 { # A ScanRun is a output-only resource representing an actual run of the scan. Next id: 12 173 "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user. 174 "errorTrace": { # Output only. Defines an error trace message for a ScanRun. # If result_state is an ERROR, this field provides the primary reason for scan's termination and more details, if such are available. 175 "code": "A String", # Indicates the error reason code. 176 "mostCommonHttpErrorCode": 42, # If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most common HTTP error code, if such is available. For example, if this code is 404, the scan has encountered too many NOT_FOUND responses. 177 "scanConfigError": { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig APIs when scan configuration validation fails. It is also reported as part of a ScanRunErrorTrace message if scan validation fails due to a scan configuration error. # If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error message encountered during scan configuration validation that is performed before each scan run. 178 "code": "A String", # Indicates the reason code for a configuration failure. 179 "fieldName": "A String", # Indicates the full name of the ScanConfig field that triggers this error, for example "scan_config.max_qps". This field is provided for troubleshooting purposes only and its actual value can change in the future. 180 }, 181 }, 182 "executionState": "A String", # The execution state of the ScanRun. 183 "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities. 184 "name": "A String", # The resource name of the ScanRun. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. The ScanRun IDs are generated by the system. 185 "progressPercent": 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. 186 "resultState": "A String", # The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED". 187 "startTime": "A String", # The time at which the ScanRun started. 188 "urlsCrawledCount": "A String", # 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. 189 "urlsTestedCount": "A String", # 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. 190 "warningTraces": [ # A list of warnings, if such are encountered during this scan run. 191 { # Output only. Defines a warning trace message for ScanRun. Warning traces provide customers with useful information that helps make the scanning process more effective. 192 "code": "A String", # Indicates the warning code. 193 }, 194 ], 195 }, 196 ], 197}</pre> 198</div> 199 200<div class="method"> 201 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 202 <pre>Retrieves the next page of results. 203 204Args: 205 previous_request: The request for the previous page. (required) 206 previous_response: The response from the request for the previous page. (required) 207 208Returns: 209 A request object that you can call 'execute()' on to request the next 210 page. Returns None if there are no more items in the collection. 211 </pre> 212</div> 213 214<div class="method"> 215 <code class="details" id="stop">stop(name, body=None, x__xgafv=None)</code> 216 <pre>Stops a ScanRun. The stopped ScanRun is returned. 217 218Args: 219 name: string, Required. The resource name of the ScanRun to be stopped. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. (required) 220 body: object, The request body. 221 The object takes the form of: 222 223{ # Request for the `StopScanRun` method. 224} 225 226 x__xgafv: string, V1 error format. 227 Allowed values 228 1 - v1 error format 229 2 - v2 error format 230 231Returns: 232 An object of the form: 233 234 { # A ScanRun is a output-only resource representing an actual run of the scan. Next id: 12 235 "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user. 236 "errorTrace": { # Output only. Defines an error trace message for a ScanRun. # If result_state is an ERROR, this field provides the primary reason for scan's termination and more details, if such are available. 237 "code": "A String", # Indicates the error reason code. 238 "mostCommonHttpErrorCode": 42, # If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most common HTTP error code, if such is available. For example, if this code is 404, the scan has encountered too many NOT_FOUND responses. 239 "scanConfigError": { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig APIs when scan configuration validation fails. It is also reported as part of a ScanRunErrorTrace message if scan validation fails due to a scan configuration error. # If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error message encountered during scan configuration validation that is performed before each scan run. 240 "code": "A String", # Indicates the reason code for a configuration failure. 241 "fieldName": "A String", # Indicates the full name of the ScanConfig field that triggers this error, for example "scan_config.max_qps". This field is provided for troubleshooting purposes only and its actual value can change in the future. 242 }, 243 }, 244 "executionState": "A String", # The execution state of the ScanRun. 245 "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities. 246 "name": "A String", # The resource name of the ScanRun. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. The ScanRun IDs are generated by the system. 247 "progressPercent": 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. 248 "resultState": "A String", # The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED". 249 "startTime": "A String", # The time at which the ScanRun started. 250 "urlsCrawledCount": "A String", # 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. 251 "urlsTestedCount": "A String", # 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. 252 "warningTraces": [ # A list of warnings, if such are encountered during this scan run. 253 { # Output only. Defines a warning trace message for ScanRun. Warning traces provide customers with useful information that helps make the scanning process more effective. 254 "code": "A String", # Indicates the warning code. 255 }, 256 ], 257}</pre> 258</div> 259 260</body></html>