WebSecurityScanner

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

Scans your Compute and App Engine apps for common web vulnerabilities.

class WebSecurityScanner {

constructor(client?: CredentialsClient, baseUrl?: string);

async projectsScanConfigsCreate(parent: string, req: ScanConfig): Promise<ScanConfig>;

async projectsScanConfigsDelete(name: string): Promise<Empty>;

async projectsScanConfigsGet(name: string): Promise<ScanConfig>;

async projectsScanConfigsList(parent: string, opts?: ProjectsScanConfigsListOptions): Promise<ListScanConfigsResponse>;

async projectsScanConfigsPatch(

name: string,

req: ScanConfig,

opts?: ProjectsScanConfigsPatchOptions,

): Promise<ScanConfig>;

async projectsScanConfigsScanRunsCrawledUrlsList(parent: string, opts?: ProjectsScanConfigsScanRunsCrawledUrlsListOptions): Promise<ListCrawledUrlsResponse>;

async projectsScanConfigsScanRunsFindingsGet(name: string): Promise<Finding>;

async projectsScanConfigsScanRunsFindingsList(parent: string, opts?: ProjectsScanConfigsScanRunsFindingsListOptions): Promise<ListFindingsResponse>;

async projectsScanConfigsScanRunsFindingTypeStatsList(parent: string): Promise<ListFindingTypeStatsResponse>;

async projectsScanConfigsScanRunsGet(name: string): Promise<ScanRun>;

async projectsScanConfigsScanRunsList(parent: string, opts?: ProjectsScanConfigsScanRunsListOptions): Promise<ListScanRunsResponse>;

async projectsScanConfigsScanRunsStop(name: string, req: StopScanRunRequest): Promise<ScanRun>;

async projectsScanConfigsStart(name: string, req: StartScanRunRequest): Promise<ScanRun>;

}

§Constructors

new WebSecurityScanner(client?: CredentialsClient, baseUrl?: string)

[src]

§Methods

projectsScanConfigsCreate(parent: string, req: ScanConfig): Promise<ScanConfig>

[src]

Creates a new ScanConfig.

@param parent

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

projectsScanConfigsDelete(name: string): Promise<Empty>

[src]

Deletes an existing ScanConfig and its child resources.

@param name

Required. The resource name of the ScanConfig to be deleted. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'.

projectsScanConfigsGet(name: string): Promise<ScanConfig>

[src]

Gets a ScanConfig.

@param name

Required. The resource name of the ScanConfig to be returned. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'.

projectsScanConfigsList(parent: string, opts?: ProjectsScanConfigsListOptions): Promise<ListScanConfigsResponse>

[src]

Lists ScanConfigs under a given project.

@param parent

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

projectsScanConfigsPatch(name: string, req: ScanConfig, opts?: ProjectsScanConfigsPatchOptions): Promise<ScanConfig>

[src]

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

@param name

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

projectsScanConfigsScanRunsCrawledUrlsList(parent: string, opts?: ProjectsScanConfigsScanRunsCrawledUrlsListOptions): Promise<ListCrawledUrlsResponse>

[src]

List CrawledUrls under a given ScanRun.

@param parent

Required. The parent resource name, which should be a scan run resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.

projectsScanConfigsScanRunsFindingsGet(name: string): Promise<Finding>

[src]

Gets a Finding.

@param name

Required. The resource name of the Finding to be returned. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}/findings/{findingId}'.

projectsScanConfigsScanRunsFindingsList(parent: string, opts?: ProjectsScanConfigsScanRunsFindingsListOptions): Promise<ListFindingsResponse>

[src]

List Findings under a given ScanRun.

@param parent

Required. The parent resource name, which should be a scan run resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.

projectsScanConfigsScanRunsFindingTypeStatsList(parent: string): Promise<ListFindingTypeStatsResponse>

[src]

List all FindingTypeStats under a given ScanRun.

@param parent

Required. The parent resource name, which should be a scan run resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.

projectsScanConfigsScanRunsGet(name: string): Promise<ScanRun>

[src]

Gets a ScanRun.

@param name

Required. The resource name of the ScanRun to be returned. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.

projectsScanConfigsScanRunsList(parent: string, opts?: ProjectsScanConfigsScanRunsListOptions): Promise<ListScanRunsResponse>

[src]

Lists ScanRuns under a given ScanConfig, in descending order of ScanRun stop time.

@param parent

Required. The parent resource name, which should be a scan resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}'.

projectsScanConfigsScanRunsStop(name: string, req: StopScanRunRequest): Promise<ScanRun>

[src]

Stops a ScanRun. The stopped ScanRun is returned.

@param name

Required. The resource name of the ScanRun to be stopped. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.

projectsScanConfigsStart(name: string, req: StartScanRunRequest): Promise<ScanRun>

[src]

Start a ScanRun according to the given ScanConfig.

@param name

Required. The resource name of the ScanConfig to be used. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'.