Checks API
The Checks API contains powerful and easy-to-use privacy and compliance APIs that interact with the Checks product and its underlying technology.
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
The Checks API contains powerful and easy-to-use privacy and compliance APIs that interact with the Checks product and its underlying technology.
Endpoints 11
accounts.repos.scans
- GETGets a repo scan
/v1alpha/:nameGets a repo scan. By default, only the name and results_uri fields are returned. You can include other fields by listing them in the fields URL query… - POSTUploads the results of local Code Compliance analysis and generates a scan of privacy issues
/v1alpha/:parent/scans:generateUploads the results of local Code Compliance analysis and generates a scan of privacy issues. Returns a google.longrunning.Operation containing analysis and… - GETLists repo scans for the specified repo.
/v1alpha/:parent/scans?filter=string&pageSize=0&pageToken=stringLists repo scans for the specified repo.
accounts.apps.operations
- DELETEDeletes a long-running operation
/v1alpha/: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… - POSTStarts asynchronous cancellation on a long-running operation
/v1alpha/: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… - GETLists operations that match the specified filter in the request
/v1alpha/: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…
/v1alpha/:name:waitWaits 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,…
accounts.apps
- GETLists the apps under the given account.
/v1alpha/:parent/apps?pageSize=0&pageToken=stringLists the apps under the given account.
accounts.apps.reports
- GETLists reports for the specified app
/v1alpha/:parent/reports?checksFilter=string&filter=string&pageSize=0&pageToken=stringLists reports for the specified app. By default, only the name and results_uri fields are returned. You can include other fields by listing them in the fields…
aisafety
- POSTAnalyze a piece of content with the provided set of policies.
/v1alpha/aisafety:classifyContentAnalyze a piece of content with the provided set of policies.
media
- POSTAnalyzes the uploaded app bundle and returns a google.longrunning.Operation containing the generated Report
/v1alpha/:parent/reports:analyzeUploadAnalyzes the uploaded app bundle and returns a google.longrunning.Operation containing the generated Report. ## Example (upload only) Send a regular POST…
API details
- Base URL
https://checks.googleapis.com- Authentication
- OAuth 2.0 (authorization code flow)
An API key in the key query parameter - Operations
- 11 operations on 10 pathsGET 5POST 5DELETE 1
- Main resources
- accounts.apps.operations 4accounts.repos.scans 3accounts.apps 1accounts.apps.reports 1aisafety 1media 1
- Response formats
application/json- Description format
- Google API Discovery, API version
v1alpha - Links
- Documentation · OpenAPI document
- Listed from
- Google API Discovery document (googleapis/discovery-artifact-manager) (Apache-2.0)
How to test the Checks 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 Checks API collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (authorization code flow). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Gets a repo scan” (GET /v1alpha/:name), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Checks API?
The Checks API contains powerful and easy-to-use privacy and compliance APIs that interact with the Checks product and its underlying technology. It is listed under Developer tools and has 11 endpoints.
Who publishes the Checks 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 Checks API?
Requests go to https://checks.googleapis.com. Endpoint paths are added to this base URL.
How do I authenticate with the Checks API?
It accepts 2 methods: OAuth 2.0 (authorization code flow); an API key in the key query parameter.
How many endpoints does the Checks API have?
11 operations on 10 paths (5 GET, 5 POST, 1 DELETE). The largest groups are accounts.apps.operations, accounts.repos.scans, accounts.apps, accounts.apps.reports.
Is forking the Checks API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.