Class ScanConfig (1.14.2)

ScanConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A ScanConfig resource contains the configurations to launch a scan.


name str
The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.
display_name str
Required. The user provided display name of the ScanConfig.
max_qps int
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.
starting_urls MutableSequence[str]
Required. The starting URLs from which the scanner finds site pages.
The authentication configuration. If specified, service will use the authentication configuration during scanning.
The user agent used during scanning.
blacklist_patterns MutableSequence[str]
The excluded URL patterns as described in
The schedule of the ScanConfig.
Controls export of scan configurations and results to Security Command Center.
The risk level selected for the scan
managed_scan bool
Whether the scan config is managed by Web Security Scanner, output only.
static_ip_scan bool
Whether the scan configuration has enabled static IP address scan feature. If enabled, the scanner will access applications from static IP addresses.
ignore_http_status_errors bool
Whether to keep scanning even if most requests return HTTP error codes.



Authentication(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Scan authentication configuration.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof:



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

Values: EXPORT_TO_SECURITY_COMMAND_CENTER_UNSPECIFIED (0): Use default, which is ENABLED. ENABLED (1): Export results of this scan to Security Command Center. DISABLED (2): Do not export results of this scan to Security Command Center.



Scan risk levels supported by Web Security Scanner. LOW impact scanning will minimize requests with the potential to modify data. To achieve the maximum scan coverage, NORMAL risk level is recommended.

Values: RISK_LEVEL_UNSPECIFIED (0): Use default, which is NORMAL. NORMAL (1): Normal scanning (Recommended) LOW (2): Lower impact scanning


Schedule(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Scan schedule configuration.



Type of user agents used for scanning.

Values: USER_AGENT_UNSPECIFIED (0): The user agent is unknown. Service will default to CHROME_LINUX. CHROME_LINUX (1): Chrome on Linux. This is the service default if unspecified. CHROME_ANDROID (2): Chrome on Android. SAFARI_IPHONE (3): Safari on IPhone.