scan_runs

Creates, updates, deletes, gets or lists a scan_runs resource.

Overview

Name	scan_runs
Type	Resource
Id	google.websecurityscanner.scan_runs

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Output only. 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.
endTime	string (google-datetime)	Output only. The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
errorTrace	object	Output only. If result_state is an ERROR, this field provides the primary reason for scan's termination and more details, if such are available. (id: ScanRunErrorTrace)
executionState	string	Output only. The execution state of the ScanRun.
hasVulnerabilities	boolean	Output only. Whether the scan run has found any vulnerabilities.
progressPercent	integer (int32)	Output only. 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.
resultState	string	Output only. The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".
startTime	string (google-datetime)	Output only. The time at which the ScanRun started.
urlsCrawledCount	string (int64)	Output only. 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.
urlsTestedCount	string (int64)	Output only. 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.
warningTraces	array	Output only. A list of warnings, if such are encountered during this scan run.

list

Successful response

Name	Datatype	Description
name	string	Output only. 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.
endTime	string (google-datetime)	Output only. The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
errorTrace	object	Output only. If result_state is an ERROR, this field provides the primary reason for scan's termination and more details, if such are available. (id: ScanRunErrorTrace)
executionState	string	Output only. The execution state of the ScanRun.
hasVulnerabilities	boolean	Output only. Whether the scan run has found any vulnerabilities.
progressPercent	integer (int32)	Output only. 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.
resultState	string	Output only. The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".
startTime	string (google-datetime)	Output only. The time at which the ScanRun started.
urlsCrawledCount	string (int64)	Output only. 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.
urlsTestedCount	string (int64)	Output only. 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.
warningTraces	array	Output only. A list of warnings, if such are encountered during this scan run.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, scanConfigsId, scanRunsId		Gets a ScanRun.
list	select	projectsId, scanConfigsId	pageToken, pageSize	Lists ScanRuns under a given ScanConfig, in descending order of ScanRun stop time.
stop	exec	projectsId, scanConfigsId, scanRunsId		Stops a ScanRun. The stopped ScanRun is returned.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
projectsId	string
scanConfigsId	string
scanRunsId	string
pageSize	integer (int32)
pageToken	string

SELECT examples

get

Gets a ScanRun.

SELECT
name,
endTime,
errorTrace,
executionState,
hasVulnerabilities,
progressPercent,
resultState,
startTime,
urlsCrawledCount,
urlsTestedCount,
warningTraces
FROM google.websecurityscanner.scan_runs
WHERE projectsId = '{{ projectsId }}' -- required
AND scanConfigsId = '{{ scanConfigsId }}' -- required
AND scanRunsId = '{{ scanRunsId }}' -- required;

list

Lists ScanRuns under a given ScanConfig, in descending order of ScanRun stop time.

SELECT
name,
endTime,
errorTrace,
executionState,
hasVulnerabilities,
progressPercent,
resultState,
startTime,
urlsCrawledCount,
urlsTestedCount,
warningTraces
FROM google.websecurityscanner.scan_runs
WHERE projectsId = '{{ projectsId }}' -- required
AND scanConfigsId = '{{ scanConfigsId }}' -- required
AND pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}';

Lifecycle Methods

stop

Stops a ScanRun. The stopped ScanRun is returned.

EXEC google.websecurityscanner.scan_runs.stop 
@projectsId='{{ projectsId }}' --required, 
@scanConfigsId='{{ scanConfigsId }}' --required, 
@scanRunsId='{{ scanRunsId }}' --required;