projects

Changed on

Updates a ScanConfig. This method support partial update of a ScanConfig.

patch/v1/{+name}

Request

  • Base URL: https://websecurityscanner.googleapis.com
  • URL: https://websecurityscanner.googleapis.com/v1/{+name}
  • Auth: OAuth 2 (implicit, authorization URL https://accounts.google.com/o/oauth2/auth, scopes: https://www.googleapis.com/auth/cloud-platform) and OAuth 2 (authorization code, authorization URL https://accounts.google.com/o/oauth2/auth, token URL https://accounts.google.com/o/oauth2/token, scopes: https://www.googleapis.com/auth/cloud-platform)

Path parameters

namestring required

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.

Query parameters

updateMaskstring

Required. The update mask applies to the resource. For the FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask

Request body

blacklistPatternsstring[]

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

displayNamestring

Required. The user provided display name of the ScanConfig.

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

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

ignoreHttpStatusErrorsboolean

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

managedScanboolean

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

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.

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.

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

The risk level selected for the scan

startingUrlsstring[]

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

staticIpScanboolean

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

targetPlatformsstring[]

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

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

The user agent used during scanning.

Response

Successful response

Changes

  • f3b19e2d4b29Revision changes
    • breaking

      removed the request body

    • breaking

      removed the media type */* for the response with the status