scan_configs

Overview

Name	`scan_configs`
Type	Resource
Id	`google.websecurityscanner.scan_configs`

Name	Datatype	Description
`name`	`string`	The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.
`authentication`	`object`	Scan authentication configuration.
`blacklistPatterns`	`array`	The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
`displayName`	`string`	Required. The user provided display name of the ScanConfig.
`exportToSecurityCommandCenter`	`string`	Controls export of scan configurations and results to Security Command Center.
`ignoreHttpStatusErrors`	`boolean`	Whether to keep scanning even if most requests return HTTP error codes.
`managedScan`	`boolean`	Whether the scan config is managed by Web Security Scanner, output only.
`maxQps`	`integer`	The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error.
`riskLevel`	`string`	The risk level selected for the scan
`schedule`	`object`	Scan schedule configuration.
`startingUrls`	`array`	Required. The starting URLs from which the scanner finds site pages.
`staticIpScan`	`boolean`	Whether the scan configuration has enabled static IP address scan feature. If enabled, the scanner will access applications from static IP addresses.
`userAgent`	`string`	The user agent used during scanning.

Name	Accessible by	Required Params	Description
`get`	`SELECT`	`projectsId, scanConfigsId`	Gets a ScanConfig.
`list`	`SELECT`	`projectsId`	Lists ScanConfigs under a given project.
`create`	`INSERT`	`projectsId`	Creates a new ScanConfig.
`delete`	`DELETE`	`projectsId, scanConfigsId`	Deletes an existing ScanConfig and its child resources.
`_list`	`EXEC`	`projectsId`	Lists ScanConfigs under a given project.
`patch`	`EXEC`	`projectsId, scanConfigsId`	Updates a ScanConfig. This method support partial update of a ScanConfig.
`start`	`EXEC`	`projectsId, scanConfigsId`	Start a ScanRun according to the given ScanConfig.