Method: projects.scanConfigs.start

Start a ScanRun according to the given ScanConfig.

HTTP request

POST https://websecurityscanner.googleapis.com/v1beta/{name=projects/*/scanConfigs/*}:start

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The resource name of the ScanConfig to be used. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'.

Authorization requires the following Google IAM permission on the specified resource name:

  • cloudsecurityscanner.scans.run

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of ScanRun.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

Try it!

Was this page helpful? Let us know how we did:

Send feedback about...

Web Security Scanner Documentation