Google

Web Security Scanner API

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

Identity & security#openapi#analytics#media

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

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

Endpoints 11

projects.scanConfigs

  • GETLists ScanConfigs under a given project./v1/:parent/scanConfigs?pageSize=0&pageToken=stringLists ScanConfigs under a given project.
  • POSTCreates a new ScanConfig./v1/:parent/scanConfigsCreates a new ScanConfig.
  • DELETEDeletes an existing ScanConfig and its child resources./v1/:nameDeletes an existing ScanConfig and its child resources.
  • PATCHUpdates a ScanConfig/v1/:name?updateMask=stringUpdates a ScanConfig. This method supports partial update of a ScanConfig. Authorization requires the following IAM permission on the specified resource…
  • POSTStart a ScanRun according to the given ScanConfig./v1/:name:startStart a ScanRun according to the given ScanConfig.

projects.scanConfigs.scanRuns.findings

  • GETGets a Finding./v1/:nameGets a Finding.
  • GETList Findings under a given ScanRun./v1/:parent/findings?filter=string&pageSize=0&pageToken=stringList Findings under a given ScanRun.

projects.scanConfigs.scanRuns

  • GETLists ScanRuns under a given ScanConfig, in descending order of ScanRun stop time./v1/:parent/scanRuns?pageSize=0&pageToken=stringLists ScanRuns under a given ScanConfig, in descending order of ScanRun stop time.
  • POSTStops a ScanRun/v1/:name:stopStops a ScanRun. The stopped ScanRun is returned.

projects.scanConfigs.scanRuns.crawledUrls

  • GETList CrawledUrls under a given ScanRun./v1/:parent/crawledUrls?pageSize=0&pageToken=stringList CrawledUrls under a given ScanRun.

projects.scanConfigs.scanRuns.findingTypeStats

  • GETList all FindingTypeStats under a given ScanRun./v1/:parent/findingTypeStatsList all FindingTypeStats under a given ScanRun.

API details

Base URL
https://websecurityscanner.googleapis.com
Authentication
OAuth 2.0 (authorization code flow) with 1 scope
An API key in the key query parameter
Operations
11 operations on 8 pathsGET 6POST 3PATCH 1DELETE 1
Main resources
projects.scanConfigs 5projects.scanConfigs.scanRuns 2projects.scanConfigs.scanRuns.findings 2projects.scanConfigs.scanRuns.crawledUrls 1projects.scanConfigs.scanRuns.findingTypeStats 1
Response formats
application/json
Description format
Google API Discovery, API version v1

How to test the Web Security Scanner API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Web Security Scanner API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Lists ScanConfigs under a given project.” (GET /v1/:parent/scanConfigs?pageSize=0&pageToken=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Web Security Scanner API?

Scans your Compute and App Engine apps for common web vulnerabilities. It is listed under Identity & security and has 11 endpoints.

Who publishes the Web Security Scanner API?

It is listed from Google's public API description (an OpenAPI document), not published by Google on Swastik Codes. Anyone who controls googleapis.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Web Security Scanner API?

Requests go to https://websecurityscanner.googleapis.com. Endpoint paths are added to this base URL.

How do I authenticate with the Web Security Scanner API?

It accepts 2 methods: OAuth 2.0 (authorization code flow) with 1 scope; an API key in the key query parameter.

How many endpoints does the Web Security Scanner API have?

11 operations on 8 paths (6 GET, 3 POST, 1 PATCH, 1 DELETE). The largest groups are projects.scanConfigs, projects.scanConfigs.scanRuns, projects.scanConfigs.scanRuns.findings, projects.scanConfigs.scanRuns.crawledUrls.

Is forking the Web Security Scanner API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.