REST Resource: projects.scanConfigs.scanRuns

Resource: ScanRun

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

JSON representation
{
  "name": string,
  "executionState": enum(ExecutionState),
  "resultState": enum(ResultState),
  "startTime": string,
  "endTime": string,
  "urlsCrawledCount": string,
  "urlsTestedCount": string,
  "hasVulnerabilities": boolean,
  "progressPercent": number
}
Fields
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.

executionState

enum(ExecutionState)

Output only. The execution state of the ScanRun.

resultState

enum(ResultState)

Output only. The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".

startTime

string (Timestamp format)

Output only. The time at which the ScanRun started.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

endTime

string (Timestamp format)

Output only. The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

urlsCrawledCount

string (int64 format)

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 format)

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.

hasVulnerabilities

boolean

Output only. Whether the scan run has found any vulnerabilities.

progressPercent

number

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.

ExecutionState

Types of ScanRun execution state.

Enums
EXECUTION_STATE_UNSPECIFIED Represents an invalid state caused by internal server error. This value should never be returned.
QUEUED The scan is waiting in the queue.
SCANNING The scan is in progress.
FINISHED The scan is either finished or stopped by user.

ResultState

Types of ScanRun result state.

Enums
RESULT_STATE_UNSPECIFIED Default value. This value is returned when the ScanRun is not yet finished.
SUCCESS The scan finished without errors.
ERROR The scan finished with errors.
KILLED The scan was terminated by user.

Methods

get

Gets a ScanRun.

list

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

stop

Stops a ScanRun.
Was this page helpful? Let us know how we did:

Send feedback about...

Cloud Security Scanner