Method: projects.scanConfigs.scanRuns.stop

Stops a ScanRun. The stopped ScanRun is returned.

HTTP request


The URL uses gRPC Transcoding syntax.

Path parameters



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 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:


For more information, see the Authentication Overview.