Method: projects.scanConfigs.scanRuns.stop

• HTTP request
• Path parameters
• Request body
• Response body
• Authorization Scopes
• Try it!

Stops a ScanRun. The stopped ScanRun is returned.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name	string Required. The resource name of the ScanRun to be stopped. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. Authorization requires the following Google IAM permission on the specified resource name: cloudsecurityscanner.scanruns.stop

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!