Blame - docs/dyn/websecurityscanner_v1beta.projects.scanConfigs.html - platform/external/python/google-api-python-client

2020-10-06 16:46:05 -0700

[diff] [blame]

83

<code><a href="#close">close()</a></code></p>

84

<p class="firstline">Close httplib2 connections.</p>

85

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

86

<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

87

<p class="firstline">Creates a new ScanConfig.</p>

88

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

92

<code><a href="#get">get(name, x__xgafv=None)</a></code></p>

93

<p class="firstline">Gets a ScanConfig.</p>

94

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

95

<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

96

<p class="firstline">Lists ScanConfigs under a given project.</p>

97

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

101

<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

102

<p class="firstline">Updates a ScanConfig. This method support partial update of a ScanConfig.</p>

103

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

108

<code class="details" id="close">close()</code>

109

<pre>Close httplib2 connections.</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

113

<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

114

<pre>Creates a new ScanConfig.

115

116

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

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)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

118

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

119

The object takes the form of:

120

121

{ # A ScanConfig resource contains the configurations to launch a scan.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

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.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

127

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

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

"iapCredential": { # Describes authentication configuration for Identity-Aware-Proxy (IAP). # Authentication using Identity-Aware-Proxy (IAP).

133

"iapTestServiceAccountInfo": { # Describes authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies. # Authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies.

134

"targetAudienceClientId": "A String", # Required. Describes OAuth2 Client ID of resources protected by Identity-Aware-Proxy(IAP).

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

135

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

136

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

137

},

138

"blacklistPatterns": [ # The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls

139

"A String",

140

],

141

"displayName": "A String", # Required. The user provided display name of the ScanConfig.

142

"exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security Command Center.

yoshi-code-bot

2021-04-21 15:07:48 -0700

[diff] [blame]

143

"ignoreHttpStatusErrors": True or False, # Whether to keep scanning even if most requests return HTTP error codes.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

144

"latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. Next id: 12 # Latest ScanRun if available.

145

"endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.

146

"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.

147

"code": "A String", # Indicates the error reason code.

148

"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.

149

"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.

150

"code": "A String", # Indicates the reason code for a configuration failure.

151

"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.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

152

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

153

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

154

"executionState": "A String", # The execution state of the ScanRun.

155

"hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.

156

"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.

157

"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.

158

"resultState": "A String", # The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".

159

"startTime": "A String", # The time at which the ScanRun started.

160

"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.

161

"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.

162

"warningTraces": [ # A list of warnings, if such are encountered during this scan run.

163

{ # Output only. Defines a warning trace message for ScanRun. Warning traces provide customers with useful information that helps make the scanning process more effective.

164

"code": "A String", # Indicates the warning code.

165

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

166

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

167

},

168

"managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output only.

169

"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.

170

"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.

171

"riskLevel": "A String", # The risk level selected for the scan

172

"schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.

173

"intervalDurationDays": 42, # Required. The duration of time between executions in days.

174

"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.

175

},

176

"startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.

177

"A String",

178

],

179

"staticIpScan": True or False, # Whether the scan configuration has enabled static IP address scan feature. If enabled, the scanner will access applications from static IP addresses.

180

"targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.

181

"A String",

182

],

183

"userAgent": "A String", # The user agent used during scanning.

184

}

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

185

186

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

193

194

{ # A ScanConfig resource contains the configurations to launch a scan.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

195

"authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the authentication configuration during scanning.

196

"customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.

197

"loginUrl": "A String", # Required. The login form URL of the website.

198

"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.

199

"username": "A String", # Required. The user name of the custom account.

200

},

201

"googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.

202

"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.

203

"username": "A String", # Required. The user name of the Google account.

204

},

205

"iapCredential": { # Describes authentication configuration for Identity-Aware-Proxy (IAP). # Authentication using Identity-Aware-Proxy (IAP).

206

"iapTestServiceAccountInfo": { # Describes authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies. # Authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies.

207

"targetAudienceClientId": "A String", # Required. Describes OAuth2 Client ID of resources protected by Identity-Aware-Proxy(IAP).

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

208

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

209

},

210

},

211

"blacklistPatterns": [ # The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls

212

"A String",

213

],

214

"displayName": "A String", # Required. The user provided display name of the ScanConfig.

215

"exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security Command Center.

yoshi-code-bot

2021-04-21 15:07:48 -0700

[diff] [blame]

216

"ignoreHttpStatusErrors": True or False, # Whether to keep scanning even if most requests return HTTP error codes.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

217

"latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. Next id: 12 # Latest ScanRun if available.

218

"endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.

219

"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.

220

"code": "A String", # Indicates the error reason code.

221

"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.

222

"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.

223

"code": "A String", # Indicates the reason code for a configuration failure.

224

"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.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

225

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

226

},

227

"executionState": "A String", # The execution state of the ScanRun.

228

"hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.

229

"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.

230

"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.

231

"resultState": "A String", # The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".

232

"startTime": "A String", # The time at which the ScanRun started.

233

"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.

234

"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.

235

"warningTraces": [ # A list of warnings, if such are encountered during this scan run.

236

{ # Output only. Defines a warning trace message for ScanRun. Warning traces provide customers with useful information that helps make the scanning process more effective.

237

"code": "A String", # Indicates the warning code.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

238

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

239

],

240

},

241

"managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output only.

242

"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.

243

"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.

244

"riskLevel": "A String", # The risk level selected for the scan

245

"schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.

246

"intervalDurationDays": 42, # Required. The duration of time between executions in days.

247

"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.

248

},

249

"startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.

250

"A String",

251

],

252

"staticIpScan": True or False, # Whether the scan configuration has enabled static IP address scan feature. If enabled, the scanner will access applications from static IP addresses.

253

"targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.

254

"A String",

255

],

256

"userAgent": "A String", # The user agent used during scanning.

257

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

<code class="details" id="delete">delete(name, x__xgafv=None)</code>

262

<pre>Deletes an existing ScanConfig and its child resources.

263

264

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

265

name: string, Required. The resource name of the ScanConfig to be deleted. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

266

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

273

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

274

{ # 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 `{}`.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

275

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

<code class="details" id="get">get(name, x__xgafv=None)</code>

280

<pre>Gets a ScanConfig.

281

282

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

283

name: string, Required. The resource name of the ScanConfig to be returned. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

284

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

291

292

{ # A ScanConfig resource contains the configurations to launch a scan.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

293

"authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the authentication configuration during scanning.

294

"customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.

295

"loginUrl": "A String", # Required. The login form URL of the website.

296

"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.

297

"username": "A String", # Required. The user name of the custom account.

298

},

299

"googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.

300

"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.

301

"username": "A String", # Required. The user name of the Google account.

302

},

303

"iapCredential": { # Describes authentication configuration for Identity-Aware-Proxy (IAP). # Authentication using Identity-Aware-Proxy (IAP).

304

"iapTestServiceAccountInfo": { # Describes authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies. # Authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies.

305

"targetAudienceClientId": "A String", # Required. Describes OAuth2 Client ID of resources protected by Identity-Aware-Proxy(IAP).

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

306

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

307

},

308

},

309

"blacklistPatterns": [ # The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls

310

"A String",

311

],

312

"displayName": "A String", # Required. The user provided display name of the ScanConfig.

313

"exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security Command Center.

yoshi-code-bot

2021-04-21 15:07:48 -0700

[diff] [blame]

314

"ignoreHttpStatusErrors": True or False, # Whether to keep scanning even if most requests return HTTP error codes.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

315

"latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. Next id: 12 # Latest ScanRun if available.

316

"endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.

317

"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.

318

"code": "A String", # Indicates the error reason code.

319

"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.

320

"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.

321

"code": "A String", # Indicates the reason code for a configuration failure.

322

"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.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

323

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

324

},

325

"executionState": "A String", # The execution state of the ScanRun.

326

"hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.

327

"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.

328

"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.

329

"resultState": "A String", # The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".

330

"startTime": "A String", # The time at which the ScanRun started.

331

"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.

332

"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.

333

"warningTraces": [ # A list of warnings, if such are encountered during this scan run.

334

{ # Output only. Defines a warning trace message for ScanRun. Warning traces provide customers with useful information that helps make the scanning process more effective.

335

"code": "A String", # Indicates the warning code.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

336

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

337

],

338

},

339

"managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output only.

340

"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.

341

"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.

342

"riskLevel": "A String", # The risk level selected for the scan

343

"schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.

344

"intervalDurationDays": 42, # Required. The duration of time between executions in days.

345

"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.

346

},

347

"startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.

348

"A String",

349

],

350

"staticIpScan": True or False, # Whether the scan configuration has enabled static IP address scan feature. If enabled, the scanner will access applications from static IP addresses.

351

"targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.

352

"A String",

353

],

354

"userAgent": "A String", # The user agent used during scanning.

355

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

359

<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

360

<pre>Lists ScanConfigs under a given project.

361

362

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

363

parent: string, Required. The parent resource name, which should be a project resource name in the format 'projects/{projectId}'. (required)

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

364

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.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

365

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 Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

366

x__xgafv: string, V1 error format.

367

Allowed values

368

1 - v1 error format

369

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

370

371

Returns:

372

An object of the form:

373

374

{ # Response for the `ListScanConfigs` method.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

375

"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.

376

"scanConfigs": [ # The list of ScanConfigs returned.

377

{ # A ScanConfig resource contains the configurations to launch a scan.

378

"authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the authentication configuration during scanning.

379

"customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.

380

"loginUrl": "A String", # Required. The login form URL of the website.

381

"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.

382

"username": "A String", # Required. The user name of the custom account.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

383

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

384

"googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.

385

"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.

386

"username": "A String", # Required. The user name of the Google account.

387

},

388

"iapCredential": { # Describes authentication configuration for Identity-Aware-Proxy (IAP). # Authentication using Identity-Aware-Proxy (IAP).

389

"iapTestServiceAccountInfo": { # Describes authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies. # Authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies.

390

"targetAudienceClientId": "A String", # Required. Describes OAuth2 Client ID of resources protected by Identity-Aware-Proxy(IAP).

},

},

},

"blacklistPatterns": [ # The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls

395

"A String",

396

],

397

"displayName": "A String", # Required. The user provided display name of the ScanConfig.

398

"exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security Command Center.

yoshi-code-bot

2021-04-21 15:07:48 -0700

[diff] [blame]

399

"ignoreHttpStatusErrors": True or False, # Whether to keep scanning even if most requests return HTTP error codes.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

400

"latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. Next id: 12 # Latest ScanRun if available.

401

"endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.

402

"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.

403

"code": "A String", # Indicates the error reason code.

404

"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.

405

"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.

406

"code": "A String", # Indicates the reason code for a configuration failure.

407

"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.

408

},

409

},

410

"executionState": "A String", # The execution state of the ScanRun.

411

"hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.

412

"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.

413

"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.

414

"resultState": "A String", # The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".

415

"startTime": "A String", # The time at which the ScanRun started.

416

"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.

417

"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.

418

"warningTraces": [ # A list of warnings, if such are encountered during this scan run.

419

{ # Output only. Defines a warning trace message for ScanRun. Warning traces provide customers with useful information that helps make the scanning process more effective.

420

"code": "A String", # Indicates the warning code.

},

],

},

"managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output only.

425

"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.

426

"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.

427

"riskLevel": "A String", # The risk level selected for the scan

428

"schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.

429

"intervalDurationDays": 42, # Required. The duration of time between executions in days.

430

"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.

431

},

432

"startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.

433

"A String",

434

],

435

"staticIpScan": True or False, # Whether the scan configuration has enabled static IP address scan feature. If enabled, the scanner will access applications from static IP addresses.

436

"targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.

437

"A String",

438

],

439

"userAgent": "A String", # The user agent used during scanning.

440

},

441

],

442

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

447

<pre>Retrieves the next page of results.

448

449

Args:

450

previous_request: The request for the previous page. (required)

451

previous_response: The response from the request for the previous page. (required)

452

453

Returns:

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

454

A request object that you can call 'execute()' on to request the next

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

455

page. Returns None if there are no more items in the collection.

</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

460

<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

461

<pre>Updates a ScanConfig. This method support partial update of a ScanConfig.

462

463

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

464

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)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

465

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

466

The object takes the form of:

467

468

{ # A ScanConfig resource contains the configurations to launch a scan.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

469

"authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the authentication configuration during scanning.

470

"customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.

471

"loginUrl": "A String", # Required. The login form URL of the website.

472

"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.

473

"username": "A String", # Required. The user name of the custom account.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

474

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

475

"googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.

476

"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.

477

"username": "A String", # Required. The user name of the Google account.

478

},

479

"iapCredential": { # Describes authentication configuration for Identity-Aware-Proxy (IAP). # Authentication using Identity-Aware-Proxy (IAP).

480

"iapTestServiceAccountInfo": { # Describes authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies. # Authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies.

481

"targetAudienceClientId": "A String", # Required. Describes OAuth2 Client ID of resources protected by Identity-Aware-Proxy(IAP).

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

482

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

483

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

484

},

485

"blacklistPatterns": [ # The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls

486

"A String",

487

],

488

"displayName": "A String", # Required. The user provided display name of the ScanConfig.

489

"exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security Command Center.

yoshi-code-bot

2021-04-21 15:07:48 -0700

[diff] [blame]

490

"ignoreHttpStatusErrors": True or False, # Whether to keep scanning even if most requests return HTTP error codes.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

491

"latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. Next id: 12 # Latest ScanRun if available.

492

"endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.

493

"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.

494

"code": "A String", # Indicates the error reason code.

495

"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.

496

"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.

497

"code": "A String", # Indicates the reason code for a configuration failure.

498

"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.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

499

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

500

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

501

"executionState": "A String", # The execution state of the ScanRun.

502

"hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.

503

"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.

504

"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.

505

"resultState": "A String", # The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".

506

"startTime": "A String", # The time at which the ScanRun started.

507

"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.

508

"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.

509

"warningTraces": [ # A list of warnings, if such are encountered during this scan run.

510

{ # Output only. Defines a warning trace message for ScanRun. Warning traces provide customers with useful information that helps make the scanning process more effective.

511

"code": "A String", # Indicates the warning code.

512

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

513

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

514

},

515

"managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output only.

516

"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.

517

"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.

518

"riskLevel": "A String", # The risk level selected for the scan

519

"schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.

520

"intervalDurationDays": 42, # Required. The duration of time between executions in days.

521

"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.

522

},

523

"startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.

524

"A String",

525

],

526

"staticIpScan": True or False, # Whether the scan configuration has enabled static IP address scan feature. If enabled, the scanner will access applications from static IP addresses.

527

"targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.

528

"A String",

529

],

530

"userAgent": "A String", # The user agent used during scanning.

531

}

Bu Sun Kim

d059ad8

2020-07-22 17:02:09 -0700

[diff] [blame]

532

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

533

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

Bu Sun Kim

d059ad8

2020-07-22 17:02:09 -0700

[diff] [blame]

534

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

541

542

{ # A ScanConfig resource contains the configurations to launch a scan.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

543

"authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the authentication configuration during scanning.

544

"customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.

545

"loginUrl": "A String", # Required. The login form URL of the website.

546

"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.

547

"username": "A String", # Required. The user name of the custom account.

548

},

549

"googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.

550

"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.

551

"username": "A String", # Required. The user name of the Google account.

552

},

553

"iapCredential": { # Describes authentication configuration for Identity-Aware-Proxy (IAP). # Authentication using Identity-Aware-Proxy (IAP).

554

"iapTestServiceAccountInfo": { # Describes authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies. # Authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies.

555

"targetAudienceClientId": "A String", # Required. Describes OAuth2 Client ID of resources protected by Identity-Aware-Proxy(IAP).

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

556

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

557

},

558

},

559

"blacklistPatterns": [ # The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls

560

"A String",

561

],

562

"displayName": "A String", # Required. The user provided display name of the ScanConfig.

563

"exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security Command Center.

yoshi-code-bot

2021-04-21 15:07:48 -0700

[diff] [blame]

564

"ignoreHttpStatusErrors": True or False, # Whether to keep scanning even if most requests return HTTP error codes.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

565

"latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. Next id: 12 # Latest ScanRun if available.

566

"endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.

567

"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.

568

"code": "A String", # Indicates the error reason code.

569

"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.

570

"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.

571

"code": "A String", # Indicates the reason code for a configuration failure.

572

"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.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

573

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

574

},

575

"executionState": "A String", # The execution state of the ScanRun.

576

"hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.

577

"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.

578

"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.

579

"resultState": "A String", # The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".

580

"startTime": "A String", # The time at which the ScanRun started.

581

"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.

582

"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.

583

"warningTraces": [ # A list of warnings, if such are encountered during this scan run.

584

{ # Output only. Defines a warning trace message for ScanRun. Warning traces provide customers with useful information that helps make the scanning process more effective.

585

"code": "A String", # Indicates the warning code.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

586

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

587

],

588

},

589

"managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output only.

590

"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.

591

"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.

592

"riskLevel": "A String", # The risk level selected for the scan

593

"schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.

594

"intervalDurationDays": 42, # Required. The duration of time between executions in days.

595

"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.

596

},

597

"startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.

598

"A String",

599

],

600

"staticIpScan": True or False, # Whether the scan configuration has enabled static IP address scan feature. If enabled, the scanner will access applications from static IP addresses.

601

"targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.

602

"A String",

603

],

604

"userAgent": "A String", # The user agent used during scanning.

605

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

<code class="details" id="start">start(name, body=None, x__xgafv=None)</code>

610

<pre>Start a ScanRun according to the given ScanConfig.

611

612

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

613

name: string, Required. The resource name of the ScanConfig to be used. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

614

body: object, The request body.

615

The object takes the form of:

616

617

{ # Request for the `StartScanRun` method.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

618

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

619

620

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

627

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

628

{ # A ScanRun is a output-only resource representing an actual run of the scan. Next id: 12

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

629

"endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.

630

"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.

631

"code": "A String", # Indicates the error reason code.

632

"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.

633

"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.

634

"code": "A String", # Indicates the reason code for a configuration failure.

635

"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.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

636

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

637

},

638

"executionState": "A String", # The execution state of the ScanRun.

639

"hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.

640

"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.

641

"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.

642

"resultState": "A String", # The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".

643

"startTime": "A String", # The time at which the ScanRun started.

644

"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.

645

"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.

646

"warningTraces": [ # A list of warnings, if such are encountered during this scan run.

647

{ # Output only. Defines a warning trace message for ScanRun. Warning traces provide customers with useful information that helps make the scanning process more effective.

648

"code": "A String", # Indicates the warning code.

649

},

650

],

651

}</pre>

Bu Sun Kim