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_v1alpha.html">Web Security Scanner API</a> . <a href="websecurityscanner_v1alpha.projects.html">projects</a> . <a href="websecurityscanner_v1alpha.projects.scanConfigs.html">scanConfigs</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="websecurityscanner_v1alpha.projects.scanConfigs.scanRuns.html">scanRuns()</a></code> 79</p> 80<p class="firstline">Returns the scanRuns Resource.</p> 81 82<p class="toc_element"> 83 <code><a href="#close">close()</a></code></p> 84<p class="firstline">Close httplib2 connections.</p> 85<p class="toc_element"> 86 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p> 87<p class="firstline">Creates a new ScanConfig.</p> 88<p class="toc_element"> 89 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> 90<p class="firstline">Deletes an existing ScanConfig and its child resources.</p> 91<p class="toc_element"> 92 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 93<p class="firstline">Gets a ScanConfig.</p> 94<p class="toc_element"> 95 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 96<p class="firstline">Lists ScanConfigs under a given project.</p> 97<p class="toc_element"> 98 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 99<p class="firstline">Retrieves the next page of results.</p> 100<p class="toc_element"> 101 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> 102<p class="firstline">Updates a ScanConfig. This method support partial update of a ScanConfig.</p> 103<p class="toc_element"> 104 <code><a href="#start">start(name, body=None, x__xgafv=None)</a></code></p> 105<p class="firstline">Start a ScanRun according to the given ScanConfig.</p> 106<h3>Method Details</h3> 107<div class="method"> 108 <code class="details" id="close">close()</code> 109 <pre>Close httplib2 connections.</pre> 110</div> 111 112<div class="method"> 113 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> 114 <pre>Creates a new ScanConfig. 115 116Args: 117 parent: string, Required. The parent resource name where the scan is created, which should be a project resource name in the format 'projects/{projectId}'. (required) 118 body: object, The request body. 119 The object takes the form of: 120 121{ # A ScanConfig resource contains the configurations to launch a scan. next id: 12 122 "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the authentication configuration during scanning. 123 "customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account. 124 "loginUrl": "A String", # Required. The login form URL of the website. 125 "password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted and not returned in any response nor included in audit logs. 126 "username": "A String", # Required. The user name of the custom account. 127 }, 128 "googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account. 129 "password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted and not returned in any response nor included in audit logs. 130 "username": "A String", # Required. The user name of the Google account. 131 }, 132 }, 133 "blacklistPatterns": [ # The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls 134 "A String", 135 ], 136 "displayName": "A String", # Required. The user provided display name of the ScanConfig. 137 "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available. 138 "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user. 139 "executionState": "A String", # The execution state of the ScanRun. 140 "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities. 141 "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. 142 "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. 143 "resultState": "A String", # The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED". 144 "startTime": "A String", # The time at which the ScanRun started. 145 "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. 146 "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. 147 }, 148 "maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error. 149 "name": "A String", # The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system. 150 "schedule": { # Scan schedule configuration. # The schedule of the ScanConfig. 151 "intervalDurationDays": 42, # Required. The duration of time between executions in days. 152 "scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is refreshed by the server after each run. If unspecified, it will default to current server time, which means the scan will be scheduled to start immediately. 153 }, 154 "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages. 155 "A String", 156 ], 157 "targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default. 158 "A String", 159 ], 160 "userAgent": "A String", # The user agent used during scanning. 161} 162 163 x__xgafv: string, V1 error format. 164 Allowed values 165 1 - v1 error format 166 2 - v2 error format 167 168Returns: 169 An object of the form: 170 171 { # A ScanConfig resource contains the configurations to launch a scan. next id: 12 172 "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the authentication configuration during scanning. 173 "customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account. 174 "loginUrl": "A String", # Required. The login form URL of the website. 175 "password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted and not returned in any response nor included in audit logs. 176 "username": "A String", # Required. The user name of the custom account. 177 }, 178 "googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account. 179 "password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted and not returned in any response nor included in audit logs. 180 "username": "A String", # Required. The user name of the Google account. 181 }, 182 }, 183 "blacklistPatterns": [ # The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls 184 "A String", 185 ], 186 "displayName": "A String", # Required. The user provided display name of the ScanConfig. 187 "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available. 188 "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user. 189 "executionState": "A String", # The execution state of the ScanRun. 190 "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities. 191 "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. 192 "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. 193 "resultState": "A String", # The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED". 194 "startTime": "A String", # The time at which the ScanRun started. 195 "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. 196 "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. 197 }, 198 "maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error. 199 "name": "A String", # The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system. 200 "schedule": { # Scan schedule configuration. # The schedule of the ScanConfig. 201 "intervalDurationDays": 42, # Required. The duration of time between executions in days. 202 "scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is refreshed by the server after each run. If unspecified, it will default to current server time, which means the scan will be scheduled to start immediately. 203 }, 204 "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages. 205 "A String", 206 ], 207 "targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default. 208 "A String", 209 ], 210 "userAgent": "A String", # The user agent used during scanning. 211}</pre> 212</div> 213 214<div class="method"> 215 <code class="details" id="delete">delete(name, x__xgafv=None)</code> 216 <pre>Deletes an existing ScanConfig and its child resources. 217 218Args: 219 name: string, Required. The resource name of the ScanConfig to be deleted. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. (required) 220 x__xgafv: string, V1 error format. 221 Allowed values 222 1 - v1 error format 223 2 - v2 error format 224 225Returns: 226 An object of the form: 227 228 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. 229}</pre> 230</div> 231 232<div class="method"> 233 <code class="details" id="get">get(name, x__xgafv=None)</code> 234 <pre>Gets a ScanConfig. 235 236Args: 237 name: string, Required. The resource name of the ScanConfig to be returned. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. (required) 238 x__xgafv: string, V1 error format. 239 Allowed values 240 1 - v1 error format 241 2 - v2 error format 242 243Returns: 244 An object of the form: 245 246 { # A ScanConfig resource contains the configurations to launch a scan. next id: 12 247 "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the authentication configuration during scanning. 248 "customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account. 249 "loginUrl": "A String", # Required. The login form URL of the website. 250 "password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted and not returned in any response nor included in audit logs. 251 "username": "A String", # Required. The user name of the custom account. 252 }, 253 "googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account. 254 "password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted and not returned in any response nor included in audit logs. 255 "username": "A String", # Required. The user name of the Google account. 256 }, 257 }, 258 "blacklistPatterns": [ # The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls 259 "A String", 260 ], 261 "displayName": "A String", # Required. The user provided display name of the ScanConfig. 262 "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available. 263 "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user. 264 "executionState": "A String", # The execution state of the ScanRun. 265 "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities. 266 "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. 267 "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. 268 "resultState": "A String", # The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED". 269 "startTime": "A String", # The time at which the ScanRun started. 270 "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. 271 "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. 272 }, 273 "maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error. 274 "name": "A String", # The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system. 275 "schedule": { # Scan schedule configuration. # The schedule of the ScanConfig. 276 "intervalDurationDays": 42, # Required. The duration of time between executions in days. 277 "scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is refreshed by the server after each run. If unspecified, it will default to current server time, which means the scan will be scheduled to start immediately. 278 }, 279 "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages. 280 "A String", 281 ], 282 "targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default. 283 "A String", 284 ], 285 "userAgent": "A String", # The user agent used during scanning. 286}</pre> 287</div> 288 289<div class="method"> 290 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> 291 <pre>Lists ScanConfigs under a given project. 292 293Args: 294 parent: string, Required. The parent resource name, which should be a project resource name in the format 'projects/{projectId}'. (required) 295 pageSize: integer, The maximum number of ScanConfigs to return, can be limited by server. If not specified or not positive, the implementation will select a reasonable value. 296 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. 297 x__xgafv: string, V1 error format. 298 Allowed values 299 1 - v1 error format 300 2 - v2 error format 301 302Returns: 303 An object of the form: 304 305 { # Response for the `ListScanConfigs` method. 306 "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list. 307 "scanConfigs": [ # The list of ScanConfigs returned. 308 { # A ScanConfig resource contains the configurations to launch a scan. next id: 12 309 "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the authentication configuration during scanning. 310 "customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account. 311 "loginUrl": "A String", # Required. The login form URL of the website. 312 "password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted and not returned in any response nor included in audit logs. 313 "username": "A String", # Required. The user name of the custom account. 314 }, 315 "googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account. 316 "password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted and not returned in any response nor included in audit logs. 317 "username": "A String", # Required. The user name of the Google account. 318 }, 319 }, 320 "blacklistPatterns": [ # The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls 321 "A String", 322 ], 323 "displayName": "A String", # Required. The user provided display name of the ScanConfig. 324 "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available. 325 "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user. 326 "executionState": "A String", # The execution state of the ScanRun. 327 "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities. 328 "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. 329 "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. 330 "resultState": "A String", # The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED". 331 "startTime": "A String", # The time at which the ScanRun started. 332 "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. 333 "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. 334 }, 335 "maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error. 336 "name": "A String", # The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system. 337 "schedule": { # Scan schedule configuration. # The schedule of the ScanConfig. 338 "intervalDurationDays": 42, # Required. The duration of time between executions in days. 339 "scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is refreshed by the server after each run. If unspecified, it will default to current server time, which means the scan will be scheduled to start immediately. 340 }, 341 "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages. 342 "A String", 343 ], 344 "targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default. 345 "A String", 346 ], 347 "userAgent": "A String", # The user agent used during scanning. 348 }, 349 ], 350}</pre> 351</div> 352 353<div class="method"> 354 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 355 <pre>Retrieves the next page of results. 356 357Args: 358 previous_request: The request for the previous page. (required) 359 previous_response: The response from the request for the previous page. (required) 360 361Returns: 362 A request object that you can call 'execute()' on to request the next 363 page. Returns None if there are no more items in the collection. 364 </pre> 365</div> 366 367<div class="method"> 368 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> 369 <pre>Updates a ScanConfig. This method support partial update of a ScanConfig. 370 371Args: 372 name: string, The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system. (required) 373 body: object, The request body. 374 The object takes the form of: 375 376{ # A ScanConfig resource contains the configurations to launch a scan. next id: 12 377 "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the authentication configuration during scanning. 378 "customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account. 379 "loginUrl": "A String", # Required. The login form URL of the website. 380 "password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted and not returned in any response nor included in audit logs. 381 "username": "A String", # Required. The user name of the custom account. 382 }, 383 "googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account. 384 "password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted and not returned in any response nor included in audit logs. 385 "username": "A String", # Required. The user name of the Google account. 386 }, 387 }, 388 "blacklistPatterns": [ # The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls 389 "A String", 390 ], 391 "displayName": "A String", # Required. The user provided display name of the ScanConfig. 392 "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available. 393 "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user. 394 "executionState": "A String", # The execution state of the ScanRun. 395 "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities. 396 "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. 397 "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. 398 "resultState": "A String", # The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED". 399 "startTime": "A String", # The time at which the ScanRun started. 400 "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. 401 "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. 402 }, 403 "maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error. 404 "name": "A String", # The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system. 405 "schedule": { # Scan schedule configuration. # The schedule of the ScanConfig. 406 "intervalDurationDays": 42, # Required. The duration of time between executions in days. 407 "scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is refreshed by the server after each run. If unspecified, it will default to current server time, which means the scan will be scheduled to start immediately. 408 }, 409 "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages. 410 "A String", 411 ], 412 "targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default. 413 "A String", 414 ], 415 "userAgent": "A String", # The user agent used during scanning. 416} 417 418 updateMask: string, Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask 419 x__xgafv: string, V1 error format. 420 Allowed values 421 1 - v1 error format 422 2 - v2 error format 423 424Returns: 425 An object of the form: 426 427 { # A ScanConfig resource contains the configurations to launch a scan. next id: 12 428 "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the authentication configuration during scanning. 429 "customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account. 430 "loginUrl": "A String", # Required. The login form URL of the website. 431 "password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted and not returned in any response nor included in audit logs. 432 "username": "A String", # Required. The user name of the custom account. 433 }, 434 "googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account. 435 "password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted and not returned in any response nor included in audit logs. 436 "username": "A String", # Required. The user name of the Google account. 437 }, 438 }, 439 "blacklistPatterns": [ # The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls 440 "A String", 441 ], 442 "displayName": "A String", # Required. The user provided display name of the ScanConfig. 443 "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available. 444 "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user. 445 "executionState": "A String", # The execution state of the ScanRun. 446 "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities. 447 "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. 448 "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. 449 "resultState": "A String", # The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED". 450 "startTime": "A String", # The time at which the ScanRun started. 451 "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. 452 "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. 453 }, 454 "maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error. 455 "name": "A String", # The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system. 456 "schedule": { # Scan schedule configuration. # The schedule of the ScanConfig. 457 "intervalDurationDays": 42, # Required. The duration of time between executions in days. 458 "scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is refreshed by the server after each run. If unspecified, it will default to current server time, which means the scan will be scheduled to start immediately. 459 }, 460 "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages. 461 "A String", 462 ], 463 "targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default. 464 "A String", 465 ], 466 "userAgent": "A String", # The user agent used during scanning. 467}</pre> 468</div> 469 470<div class="method"> 471 <code class="details" id="start">start(name, body=None, x__xgafv=None)</code> 472 <pre>Start a ScanRun according to the given ScanConfig. 473 474Args: 475 name: string, Required. The resource name of the ScanConfig to be used. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. (required) 476 body: object, The request body. 477 The object takes the form of: 478 479{ # Request for the `StartScanRun` method. 480} 481 482 x__xgafv: string, V1 error format. 483 Allowed values 484 1 - v1 error format 485 2 - v2 error format 486 487Returns: 488 An object of the form: 489 490 { # A ScanRun is a output-only resource representing an actual run of the scan. 491 "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user. 492 "executionState": "A String", # The execution state of the ScanRun. 493 "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities. 494 "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. 495 "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. 496 "resultState": "A String", # The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED". 497 "startTime": "A String", # The time at which the ScanRun started. 498 "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. 499 "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. 500}</pre> 501</div> 502 503</body></html>