ScanConfig

import type { ScanConfig } from "https://googleapis.deno.dev/v1/websecurityscanner:v1.ts";

A ScanConfig resource contains the configurations to launch a scan.

interface ScanConfig {

authentication?: Authentication;

blacklistPatterns?: string[];

displayName?: string;

exportToSecurityCommandCenter?: "EXPORT_TO_SECURITY_COMMAND_CENTER_UNSPECIFIED" | "ENABLED" | "DISABLED";

ignoreHttpStatusErrors?: boolean;

managedScan?: boolean;

maxQps?: number;

name?: string;

riskLevel?: "RISK_LEVEL_UNSPECIFIED" | "NORMAL" | "LOW";

schedule?: Schedule;

startingUrls?: string[];

staticIpScan?: boolean;

userAgent?:

| "USER_AGENT_UNSPECIFIED"

| "CHROME_LINUX"

| "CHROME_ANDROID"

| "SAFARI_IPHONE";

}

§Properties

authentication?: Authentication

[src]

The authentication configuration. If specified, service will use the authentication configuration during scanning.

blacklistPatterns?: string[]

[src]

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

[src]

Required. The user provided display name of the ScanConfig.

exportToSecurityCommandCenter?: "EXPORT_TO_SECURITY_COMMAND_CENTER_UNSPECIFIED" | "ENABLED" | "DISABLED"

[src]

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

ignoreHttpStatusErrors?: boolean

[src]

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

managedScan?: boolean

[src]

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

maxQps?: number

[src]

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.

name?: string

[src]

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"

[src]

The risk level selected for the scan

schedule?: Schedule

[src]

The schedule of the ScanConfig.

startingUrls?: string[]

[src]

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

staticIpScan?: boolean

[src]

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

userAgent?: "USER_AGENT_UNSPECIFIED" | "CHROME_LINUX" | "CHROME_ANDROID" | "SAFARI_IPHONE"

[src]

The user agent used during scanning.