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

<h1><a href="websecurityscanner_v1.html">Web Security Scanner API</a> . <a href="websecurityscanner_v1.projects.html">projects</a> . <a href="websecurityscanner_v1.projects.scanConfigs.html">scanConfigs</a></h1>

76

<h2>Instance Methods</h2>

77

78

<code><a href="websecurityscanner_v1.projects.scanConfigs.scanRuns.html">scanRuns()</a></code>

79

</p>

80

<p class="firstline">Returns the scanRuns Resource.</p>

81

82

83

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

84

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

85

86

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

87

<p class="firstline">Deletes an existing ScanConfig and its child resources.</p>

88

89

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

90

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

91

92

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

93

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

94

95

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

96

<p class="firstline">Retrieves the next page of results.</p>

97

98

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

99

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

100

101

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

102

<p class="firstline">Start a ScanRun according to the given ScanConfig.</p>

103

<h3>Method Details</h3>

104

105

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

106

<pre>Creates a new ScanConfig.

107

108

Args:

109

parent: string, Required. The parent resource name where the scan is created, which should be a

110

project resource name in the format 'projects/{projectId}'. (required)

111

body: object, The request body.

112

The object takes the form of:

113

114

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

115

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

116

# Command Center.

117

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

118

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

119

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

120

"scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is

121

# refreshed by the server after each run. If unspecified, it will default

122

# to current server time, which means the scan will be scheduled to start

123

# immediately.

124

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

125

},

126

"staticIpScan": True or False, # Whether the scan configuration has enabled static IP address scan feature.

127

# If enabled, the scanner will access applications from static IP addresses.

128

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

129

"maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20

130

# inclusively. If the field is unspecified or its value is set 0, server will

131

# default to 15. Other values outside of [5, 20] range will be rejected with

132

# INVALID_ARGUMENT error.

133

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

134

# authentication configuration during scanning.

135

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

136

"iapTestServiceAccountInfo": { # Describes authentication configuration when Web-Security-Scanner # Authentication configuration when Web-Security-Scanner service

137

# account is added in Identity-Aware-Proxy (IAP) access policies.

138

# service account is added in Identity-Aware-Proxy (IAP) access policies.

139

"targetAudienceClientId": "A String", # Required. Describes OAuth2 client id of resources protected by

140

# Identity-Aware-Proxy (IAP).

141

},

142

},

143

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

144

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

145

"password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted

146

# and not returned in any response nor included in audit logs.

147

},

148

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

149

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

150

"password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted

151

# and not returned in any response nor included in audit logs.

152

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

153

},

154

},

155

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

156

# only.

157

"blacklistPatterns": [ # The blacklist URL patterns as described in

158

# https://cloud.google.com/security-scanner/docs/excluded-urls

159

"A String",

160

],

161

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

162

"A String",

163

],

164

"name": "A String", # The resource name of the ScanConfig. The name follows the format of

165

# 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are

166

# generated by the system.

167

}

168

169

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

176

177

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

178

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

179

# Command Center.

180

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

181

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

182

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

183

"scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is

184

# refreshed by the server after each run. If unspecified, it will default

185

# to current server time, which means the scan will be scheduled to start

186

# immediately.

187

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

188

},

189

"staticIpScan": True or False, # Whether the scan configuration has enabled static IP address scan feature.

190

# If enabled, the scanner will access applications from static IP addresses.

191

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

192

"maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20

193

# inclusively. If the field is unspecified or its value is set 0, server will

194

# default to 15. Other values outside of [5, 20] range will be rejected with

195

# INVALID_ARGUMENT error.

196

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

197

# authentication configuration during scanning.

198

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

199

"iapTestServiceAccountInfo": { # Describes authentication configuration when Web-Security-Scanner # Authentication configuration when Web-Security-Scanner service

200

# account is added in Identity-Aware-Proxy (IAP) access policies.

201

# service account is added in Identity-Aware-Proxy (IAP) access policies.

202

"targetAudienceClientId": "A String", # Required. Describes OAuth2 client id of resources protected by

203

# Identity-Aware-Proxy (IAP).

204

},

205

},

206

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

207

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

208

"password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted

209

# and not returned in any response nor included in audit logs.

210

},

211

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

212

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

213

"password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted

214

# and not returned in any response nor included in audit logs.

215

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

216

},

217

},

218

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

219

# only.

220

"blacklistPatterns": [ # The blacklist URL patterns as described in

221

# https://cloud.google.com/security-scanner/docs/excluded-urls

222

"A String",

223

],

224

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

225

"A String",

226

],

227

"name": "A String", # The resource name of the ScanConfig. The name follows the format of

228

# 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are

229

# generated by the system.

}</pre>

</div>

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

235

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

236

237

Args:

238

name: string, Required. The resource name of the ScanConfig to be deleted. The name follows the

239

format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. (required)

240

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

247

248

{ # A generic empty message that you can re-use to avoid defining duplicated

249

# empty messages in your APIs. A typical example is to use it as the request

250

# or the response type of an API method. For instance:

251

#

252

# service Foo {

253

# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);

254

# }

255

#

256

# The JSON representation for `Empty` is empty JSON object `{}`.

}</pre>

</div>

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

262

<pre>Gets a ScanConfig.

263

264

Args:

265

name: string, Required. The resource name of the ScanConfig to be returned. The name follows the

266

format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. (required)

267

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

274

275

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

276

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

277

# Command Center.

278

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

279

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

280

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

281

"scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is

282

# refreshed by the server after each run. If unspecified, it will default

283

# to current server time, which means the scan will be scheduled to start

284

# immediately.

285

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

286

},

287

"staticIpScan": True or False, # Whether the scan configuration has enabled static IP address scan feature.

288

# If enabled, the scanner will access applications from static IP addresses.

289

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

290

"maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20

291

# inclusively. If the field is unspecified or its value is set 0, server will

292

# default to 15. Other values outside of [5, 20] range will be rejected with

293

# INVALID_ARGUMENT error.

294

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

295

# authentication configuration during scanning.

296

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

297

"iapTestServiceAccountInfo": { # Describes authentication configuration when Web-Security-Scanner # Authentication configuration when Web-Security-Scanner service

298

# account is added in Identity-Aware-Proxy (IAP) access policies.

299

# service account is added in Identity-Aware-Proxy (IAP) access policies.

300

"targetAudienceClientId": "A String", # Required. Describes OAuth2 client id of resources protected by

301

# Identity-Aware-Proxy (IAP).

302

},

303

},

304

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

305

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

306

"password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted

307

# and not returned in any response nor included in audit logs.

308

},

309

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

310

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

311

"password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted

312

# 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

},

316

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

317

# only.

318

"blacklistPatterns": [ # The blacklist URL patterns as described in

319

# https://cloud.google.com/security-scanner/docs/excluded-urls

320

"A String",

321

],

322

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

323

"A String",

324

],

325

"name": "A String", # The resource name of the ScanConfig. The name follows the format of

326

# 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are

327

# generated by the system.

}</pre>

</div>

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

333

<pre>Lists ScanConfigs under a given project.

334

335

Args:

336

parent: string, Required. The parent resource name, which should be a project resource name in the

337

format 'projects/{projectId}'. (required)

338

pageToken: string, A token identifying a page of results to be returned. This should be a

339

`next_page_token` value returned from a previous List request.

340

If unspecified, the first page of results is returned.

341

pageSize: integer, The maximum number of ScanConfigs to return, can be limited by server.

342

If not specified or not positive, the implementation will select a

343

reasonable value.

344

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

351

352

{ # Response for the `ListScanConfigs` method.

353

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

354

# more results in the list.

355

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

356

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

357

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

358

# Command Center.

359

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

360

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

361

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

362

"scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is

363

# refreshed by the server after each run. If unspecified, it will default

364

# to current server time, which means the scan will be scheduled to start

365

# immediately.

366

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

367

},

368

"staticIpScan": True or False, # Whether the scan configuration has enabled static IP address scan feature.

369

# If enabled, the scanner will access applications from static IP addresses.

370

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

371

"maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20

372

# inclusively. If the field is unspecified or its value is set 0, server will

373

# default to 15. Other values outside of [5, 20] range will be rejected with

374

# INVALID_ARGUMENT error.

375

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

376

# authentication configuration during scanning.

377

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

378

"iapTestServiceAccountInfo": { # Describes authentication configuration when Web-Security-Scanner # Authentication configuration when Web-Security-Scanner service

379

# account is added in Identity-Aware-Proxy (IAP) access policies.

380

# service account is added in Identity-Aware-Proxy (IAP) access policies.

381

"targetAudienceClientId": "A String", # Required. Describes OAuth2 client id of resources protected by

382

# Identity-Aware-Proxy (IAP).

383

},

384

},

385

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

386

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

387

"password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted

388

# and not returned in any response nor included in audit logs.

389

},

390

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

391

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

392

"password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted

393

# and not returned in any response nor included in audit logs.

394

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

395

},

396

},

397

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

398

# only.

399

"blacklistPatterns": [ # The blacklist URL patterns as described in

400

# https://cloud.google.com/security-scanner/docs/excluded-urls

401

"A String",

402

],

403

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

404

"A String",

405

],

406

"name": "A String", # The resource name of the ScanConfig. The name follows the format of

407

# 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are

408

# generated by the system.

},

],

}</pre>

</div>

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

416

<pre>Retrieves the next page of results.

417

418

Args:

419

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

420

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

421

422

Returns:

423

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

424

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

</pre>

</div>

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

430

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

431

432

Args:

433

name: string, The resource name of the ScanConfig. The name follows the format of

434

'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are

435

generated by the system. (required)

436

body: object, The request body.

437

The object takes the form of:

438

439

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

440

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

441

# Command Center.

442

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

443

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

444

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

445

"scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is

446

# refreshed by the server after each run. If unspecified, it will default

447

# to current server time, which means the scan will be scheduled to start

448

# immediately.

449

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

450

},

451

"staticIpScan": True or False, # Whether the scan configuration has enabled static IP address scan feature.

452

# If enabled, the scanner will access applications from static IP addresses.

453

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

454

"maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20

455

# inclusively. If the field is unspecified or its value is set 0, server will

456

# default to 15. Other values outside of [5, 20] range will be rejected with

457

# INVALID_ARGUMENT error.

458

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

459

# authentication configuration during scanning.

460

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

461

"iapTestServiceAccountInfo": { # Describes authentication configuration when Web-Security-Scanner # Authentication configuration when Web-Security-Scanner service

462

# account is added in Identity-Aware-Proxy (IAP) access policies.

463

# service account is added in Identity-Aware-Proxy (IAP) access policies.

464

"targetAudienceClientId": "A String", # Required. Describes OAuth2 client id of resources protected by

465

# Identity-Aware-Proxy (IAP).

466

},

467

},

468

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

469

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

470

"password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted

471

# and not returned in any response nor included in audit logs.

472

},

473

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

474

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

475

"password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted

476

# and not returned in any response nor included in audit logs.

477

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

478

},

479

},

480

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

481

# only.

482

"blacklistPatterns": [ # The blacklist URL patterns as described in

483

# https://cloud.google.com/security-scanner/docs/excluded-urls

484

"A String",

485

],

486

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

487

"A String",

488

],

489

"name": "A String", # The resource name of the ScanConfig. The name follows the format of

490

# 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are

491

# generated by the system.

492

}

493

494

updateMask: string, Required. The update mask applies to the resource. For the `FieldMask` definition,

495

see

496

https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask

497

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

504

505

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

506

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

507

# Command Center.

508

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

509

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

510

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

511

"scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is

512

# refreshed by the server after each run. If unspecified, it will default

513

# to current server time, which means the scan will be scheduled to start

514

# immediately.

515

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

516

},

517

"staticIpScan": True or False, # Whether the scan configuration has enabled static IP address scan feature.

518

# If enabled, the scanner will access applications from static IP addresses.

519

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

520

"maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20

521

# inclusively. If the field is unspecified or its value is set 0, server will

522

# default to 15. Other values outside of [5, 20] range will be rejected with

523

# INVALID_ARGUMENT error.

524

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

525

# authentication configuration during scanning.

526

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

527

"iapTestServiceAccountInfo": { # Describes authentication configuration when Web-Security-Scanner # Authentication configuration when Web-Security-Scanner service

528

# account is added in Identity-Aware-Proxy (IAP) access policies.

529

# service account is added in Identity-Aware-Proxy (IAP) access policies.

530

"targetAudienceClientId": "A String", # Required. Describes OAuth2 client id of resources protected by

531

# Identity-Aware-Proxy (IAP).

532

},

533

},

534

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

535

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

536

"password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted

537

# and not returned in any response nor included in audit logs.

538

},

539

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

540

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

541

"password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted

542

# and not returned in any response nor included in audit logs.

543

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

544

},

545

},

546

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

547

# only.

548

"blacklistPatterns": [ # The blacklist URL patterns as described in

549

# https://cloud.google.com/security-scanner/docs/excluded-urls

550

"A String",

551

],

552

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

553

"A String",

554

],

555

"name": "A String", # The resource name of the ScanConfig. The name follows the format of

556

# 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are

557

# generated by the system.

}</pre>

</div>

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

563

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

564

565

Args:

566

name: string, Required. The resource name of the ScanConfig to be used. The name follows the

567

format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. (required)

568

body: object, The request body.

569

The object takes the form of:

570

571

{ # Request for the `StartScanRun` method.

572

}

573

574

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

581

582

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

583

# Next id: 12

584

"progressPercent": 42, # Output only. The percentage of total completion ranging from 0 to 100.

585

# If the scan is in queue, the value is 0.

586

# If the scan is running, the value ranges from 0 to 100.

587

# If the scan is finished, the value is 100.

588

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

589

"endTime": "A String", # Output only. The time at which the ScanRun reached termination state - that the ScanRun

590

# is either finished or stopped by user.

591

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

592

"urlsCrawledCount": "A String", # Output only. The number of URLs crawled during this ScanRun. If the scan is in progress,

593

# the value represents the number of URLs crawled up to now.

594

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

595

"urlsTestedCount": "A String", # Output only. The number of URLs tested during this ScanRun. If the scan is in progress,

596

# the value represents the number of URLs tested up to now. The number of

597

# URLs tested is usually larger than the number URLS crawled because

598

# typically a crawled URL is tested with multiple test payloads.

599

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

600

{ # Output only.

601

# Defines a warning trace message for ScanRun. Warning traces provide customers

602

# with useful information that helps make the scanning process more effective.

603

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

604

},

605

],

606

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

607

# execution state reaches "FINISHED".

608

"name": "A String", # Output only. The resource name of the ScanRun. The name follows the format of

609

# 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.

610

# The ScanRun IDs are generated by the system.

611

"errorTrace": { # Output only. # Output only. If result_state is an ERROR, this field provides the primary reason for

612

# scan's termination and more details, if such are available.

613

# Defines an error trace message for a ScanRun.

614

"scanConfigError": { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig # Output only. If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error

615

# message encountered during scan configuration validation that is performed

616

# before each scan run.

617

# APIs when scan configuration validation fails. It is also reported as part of

618

# a ScanRunErrorTrace message if scan validation fails due to a scan

619

# configuration error.

620

"fieldName": "A String", # Output only. Indicates the full name of the ScanConfig field that triggers this error,