Web Security Scanner API

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

Service: websecurityscanner.googleapis.com

To call this service, we recommend that you use the Google-provided client libraries. If your application needs to use your own libraries to call this service, use the following information when you make the API requests.

Discovery document

A Discovery Document is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery documents:

Service endpoint

A service endpoint is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:

  • https://websecurityscanner.googleapis.com

REST Resource: v1beta.projects.scanConfigs

Methods
create POST /v1beta/{parent=projects/*}/scanConfigs
Creates a new ScanConfig.
delete DELETE /v1beta/{name=projects/*/scanConfigs/*}
Deletes an existing ScanConfig and its child resources.
get GET /v1beta/{name=projects/*/scanConfigs/*}
Gets a ScanConfig.
list GET /v1beta/{parent=projects/*}/scanConfigs
Lists ScanConfigs under a given project.
patch PATCH /v1beta/{scanConfig.name=projects/*/scanConfigs/*}
Updates a ScanConfig.
start POST /v1beta/{name=projects/*/scanConfigs/*}:start
Start a ScanRun according to the given ScanConfig.

REST Resource: v1beta.projects.scanConfigs.scanRuns

Methods
get GET /v1beta/{name=projects/*/scanConfigs/*/scanRuns/*}
Gets a ScanRun.
list GET /v1beta/{parent=projects/*/scanConfigs/*}/scanRuns
Lists ScanRuns under a given ScanConfig, in descending order of ScanRun stop time.
stop POST /v1beta/{name=projects/*/scanConfigs/*/scanRuns/*}:stop
Stops a ScanRun.

REST Resource: v1beta.projects.scanConfigs.scanRuns.crawledUrls

Methods
list GET /v1beta/{parent=projects/*/scanConfigs/*/scanRuns/*}/crawledUrls
List CrawledUrls under a given ScanRun.

REST Resource: v1beta.projects.scanConfigs.scanRuns.findingTypeStats

Methods
list GET /v1beta/{parent=projects/*/scanConfigs/*/scanRuns/*}/findingTypeStats
List all FindingTypeStats under a given ScanRun.

REST Resource: v1beta.projects.scanConfigs.scanRuns.findings

Methods
get GET /v1beta/{name=projects/*/scanConfigs/*/scanRuns/*/findings/*}
Gets a Finding.
list GET /v1beta/{parent=projects/*/scanConfigs/*/scanRuns/*}/findings
List Findings under a given ScanRun.

REST Resource: v1.projects.scanConfigs

Methods
create POST /v1/{parent=projects/*}/scanConfigs
Creates a new ScanConfig.
delete DELETE /v1/{name=projects/*/scanConfigs/*}
Deletes an existing ScanConfig and its child resources.
get GET /v1/{name=projects/*/scanConfigs/*}
Gets a ScanConfig.
list GET /v1/{parent=projects/*}/scanConfigs
Lists ScanConfigs under a given project.
patch PATCH /v1/{scanConfig.name=projects/*/scanConfigs/*}
Updates a ScanConfig.
start POST /v1/{name=projects/*/scanConfigs/*}:start
Start a ScanRun according to the given ScanConfig.

REST Resource: v1.projects.scanConfigs.scanRuns

Methods
get GET /v1/{name=projects/*/scanConfigs/*/scanRuns/*}
Gets a ScanRun.
list GET /v1/{parent=projects/*/scanConfigs/*}/scanRuns
Lists ScanRuns under a given ScanConfig, in descending order of ScanRun stop time.
stop POST /v1/{name=projects/*/scanConfigs/*/scanRuns/*}:stop
Stops a ScanRun.

REST Resource: v1.projects.scanConfigs.scanRuns.crawledUrls

Methods
list GET /v1/{parent=projects/*/scanConfigs/*/scanRuns/*}/crawledUrls
List CrawledUrls under a given ScanRun.

REST Resource: v1.projects.scanConfigs.scanRuns.findingTypeStats

Methods
list GET /v1/{parent=projects/*/scanConfigs/*/scanRuns/*}/findingTypeStats
List all FindingTypeStats under a given ScanRun.

REST Resource: v1.projects.scanConfigs.scanRuns.findings

Methods
get GET /v1/{name=projects/*/scanConfigs/*/scanRuns/*/findings/*}
Gets a Finding.
list GET /v1/{parent=projects/*/scanConfigs/*/scanRuns/*}/findings
List Findings under a given ScanRun.