Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-13113036.3 KB
projects

Creates a new ScanConfig.

post/v1/{+parent}/scanConfigs

Path parameters

parentstring required

Required. The parent resource name where the scan is created, which should be a project resource name in the format 'projects/{projectId}'.

Request body

startingUrlsstring[]

Required. The starting URLs from which the scanner finds site pages.

ignoreHttpStatusErrorsboolean

Whether to keep scanning even if most requests return HTTP error codes.

exportToSecurityCommandCenter'EXPORT_TO_SECURITY_COMMAND_CENTER_UNSPECIFIED' | 'ENABLED' | 'DISABLED'

Controls export of scan configurations and results to Security Command Center.

staticIpScanboolean

Whether the scan configuration has enabled static IP address scan feature. If enabled, the scanner will access applications from static IP addresses.

blacklistPatternsstring[]

The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls

riskLevel'RISK_LEVEL_UNSPECIFIED' | 'NORMAL' | 'LOW'

The risk level selected for the scan

maxQpsinteger

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.

targetPlatformsstring[]

Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.

managedScanboolean

Whether the scan config is managed by Web Security Scanner, output only.

displayNamestring

Required. The user provided display name of the ScanConfig.

userAgent'USER_AGENT_UNSPECIFIED' | 'CHROME_LINUX' | 'CHROME_ANDROID' | 'SAFARI_IPHONE'

The user agent used during scanning.

namestring

Identifier. The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.

Response

Successful response