On-Demand Scanning API
A service to scan container images for vulnerabilities.
Developer tools#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
A service to scan container images for vulnerabilities.
Endpoints 7
projects.locations.operations
- POSTStarts asynchronous cancellation on a long-running operation
/v1/:name:cancelStarts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the… - GETGets the latest state of a long-running operation
/v1/:nameGets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. - DELETEDeletes a long-running operation
/v1/:nameDeletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If… - GETLists operations that match the specified filter in the request
/v1/:name/operations?filter=string&pageSize=0&pageToken=string&returnPartialSuccess=trueLists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. - POSTWaits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest…
/v1/:name:wait?timeout=stringWaits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done,…
projects.locations.scans
- POSTInitiates an analysis of the provided packages.
/v1/:parent/scans:analyzePackagesInitiates an analysis of the provided packages.
projects.locations.scans.vulnerabilities
- GETLists vulnerabilities resulting from a successfully completed scan.
/v1/:parent/vulnerabilities?pageSize=0&pageToken=stringLists vulnerabilities resulting from a successfully completed scan.
API details
- Base URL
https://ondemandscanning.googleapis.com- Authentication
- OAuth 2.0 (authorization code flow) with 1 scope
An API key in the key query parameter - Operations
- 7 operations on 6 pathsGET 3POST 3DELETE 1
- Main resources
- projects.locations.operations 5projects.locations.scans 1projects.locations.scans.vulnerabilities 1
- Response formats
application/json- Description format
- Google API Discovery, API version
v1 - Links
- Documentation · OpenAPI document
- Listed from
- Google API Discovery document (googleapis/discovery-artifact-manager) (Apache-2.0)
How to test the On-Demand Scanning API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the On-Demand Scanning API collection, without the publisher's secrets.
- 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.
- Send a requestPick an endpoint, for example “Starts asynchronous cancellation on a long-running operation” (POST /v1/:name:cancel), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the On-Demand Scanning API?
A service to scan container images for vulnerabilities. It is listed under Developer tools and has 7 endpoints.
Who publishes the On-Demand Scanning 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 On-Demand Scanning API?
Requests go to https://ondemandscanning.googleapis.com. Endpoint paths are added to this base URL.
How do I authenticate with the On-Demand Scanning 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 On-Demand Scanning API have?
7 operations on 6 paths (3 GET, 3 POST, 1 DELETE). The largest groups are projects.locations.operations, projects.locations.scans, projects.locations.scans.vulnerabilities.
Is forking the On-Demand Scanning API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.