Checks API
Stay organized with collections
Save and categorize content based on your preferences.
The Checks API contains powerful and easy-to-use privacy and compliance APIs that interact with the Checks product and its underlying technology.
Service: checks.googleapis.com
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://checks.googleapis.com
| Methods |
get |
GET /v1alpha/{name=accounts/*/apps/*}
Gets an app. |
list |
GET /v1alpha/{parent=accounts/*}/apps
Lists the apps under the given account. |
| Methods |
cancel |
POST /v1alpha/{name=accounts/*/apps/*/operations/*}:cancel
Starts asynchronous cancellation on a long-running operation. |
delete |
DELETE /v1alpha/{name=accounts/*/apps/*/operations/*}
Deletes a long-running operation. |
get |
GET /v1alpha/{name=accounts/*/apps/*/operations/*}
Gets the latest state of a long-running operation. |
list |
GET /v1alpha/{name=accounts/*/apps/*}/operations
Lists operations that match the specified filter in the request. |
wait |
POST /v1alpha/{name=accounts/*/apps/*/operations/*}:wait
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. |
| Methods |
get |
GET /v1alpha/{name=accounts/*/apps/*/reports/*}
Gets a report. |
list |
GET /v1alpha/{parent=accounts/*/apps/*}/reports
Lists reports for the specified app. |
| Methods |
get |
GET /v1alpha/{name=accounts/*/repos/*/operations/*}
Gets the latest state of a long-running operation. |
| Methods |
generate |
POST /v1alpha/{parent=accounts/*/repos/*}/scans:generate
Uploads the results of local Code Compliance analysis and generates a scan of privacy issues. |
get |
GET /v1alpha/{name=accounts/*/repos/*/scans/*}
Gets a repo scan. |
list |
GET /v1alpha/{parent=accounts/*/repos/*}/scans
Lists repo scans for the specified repo. |
| Methods |
classifyContent |
POST /v1alpha/aisafety:classifyContent
Analyze a piece of content with the provided set of policies. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-11-20 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-11-20 UTC."],[[["\u003cp\u003eThe Checks API provides privacy and compliance APIs for interacting with the Checks product.\u003c/p\u003e\n"],["\u003cp\u003eThe API offers REST resources to manage apps, operations, reports, and media analysis.\u003c/p\u003e\n"],["\u003cp\u003eYou can get, list, and manage apps, as well as their operations and reports.\u003c/p\u003e\n"],["\u003cp\u003eMedia analysis allows uploading app bundles for analysis and generating reports through asynchronous operations.\u003c/p\u003e\n"],["\u003cp\u003eThe service endpoint for the Checks API is \u003ccode\u003ehttps://checks.googleapis.com\u003c/code\u003e.\u003c/p\u003e\n"]]],[],null,["# Checks API\n\nThe Checks API contains powerful and easy-to-use privacy and compliance APIs that interact with the Checks product and its underlying technology.\n\n- [REST Resource: v1alpha.accounts.apps](#v1alpha.accounts.apps)\n- [REST Resource: v1alpha.accounts.apps.operations](#v1alpha.accounts.apps.operations)\n- [REST Resource: v1alpha.accounts.apps.reports](#v1alpha.accounts.apps.reports)\n- [REST Resource: v1alpha.accounts.repos.operations](#v1alpha.accounts.repos.operations)\n- [REST Resource: v1alpha.accounts.repos.scans](#v1alpha.accounts.repos.scans)\n- [REST Resource: v1alpha.aisafety](#v1alpha.aisafety)\n- [REST Resource: v1alpha.media](#v1alpha.media)\n\nService: checks.googleapis.com\n------------------------------\n\n### Service endpoint\n\nA [service endpoint](https://cloud.google.com/apis/design/glossary#api_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:\n\n- `https://checks.googleapis.com`\n\nREST Resource: [v1alpha.accounts.apps](/checks/reference/rest/v1alpha/accounts.apps)\n------------------------------------------------------------------------------------\n\n| Methods ||\n|-----------------------------------------------------------|---------------------------------------------------------------------------------|\n| [get](/checks/reference/rest/v1alpha/accounts.apps/get) | `GET /v1alpha/{name=accounts/*/apps/*}` Gets an app. |\n| [list](/checks/reference/rest/v1alpha/accounts.apps/list) | `GET /v1alpha/{parent=accounts/*}/apps` Lists the apps under the given account. |\n\nREST Resource: [v1alpha.accounts.apps.operations](/checks/reference/rest/v1alpha/accounts.apps.operations)\n----------------------------------------------------------------------------------------------------------\n\n| Methods ||\n|--------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [cancel](/checks/reference/rest/v1alpha/accounts.apps.operations/cancel) | `POST /v1alpha/{name=accounts/*/apps/*/operations/*}:cancel` Starts asynchronous cancellation on a long-running operation. |\n| [delete](/checks/reference/rest/v1alpha/accounts.apps.operations/delete) | `DELETE /v1alpha/{name=accounts/*/apps/*/operations/*}` Deletes a long-running operation. |\n| [get](/checks/reference/rest/v1alpha/accounts.apps.operations/get) | `GET /v1alpha/{name=accounts/*/apps/*/operations/*}` Gets the latest state of a long-running operation. |\n| [list](/checks/reference/rest/v1alpha/accounts.apps.operations/list) | `GET /v1alpha/{name=accounts/*/apps/*}/operations` Lists operations that match the specified filter in the request. |\n| [wait](/checks/reference/rest/v1alpha/accounts.apps.operations/wait) | `POST /v1alpha/{name=accounts/*/apps/*/operations/*}:wait` Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. |\n\nREST Resource: [v1alpha.accounts.apps.reports](/checks/reference/rest/v1alpha/accounts.apps.reports)\n----------------------------------------------------------------------------------------------------\n\n| Methods ||\n|-------------------------------------------------------------------|----------------------------------------------------------------------------------------|\n| [get](/checks/reference/rest/v1alpha/accounts.apps.reports/get) | `GET /v1alpha/{name=accounts/*/apps/*/reports/*}` Gets a report. |\n| [list](/checks/reference/rest/v1alpha/accounts.apps.reports/list) | `GET /v1alpha/{parent=accounts/*/apps/*}/reports` Lists reports for the specified app. |\n\nREST Resource: [v1alpha.accounts.repos.operations](/checks/reference/rest/v1alpha/accounts.repos.operations)\n------------------------------------------------------------------------------------------------------------\n\n| Methods ||\n|---------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------|\n| [get](/checks/reference/rest/v1alpha/accounts.repos.operations/get) | `GET /v1alpha/{name=accounts/*/repos/*/operations/*}` Gets the latest state of a long-running operation. |\n\nREST Resource: [v1alpha.accounts.repos.scans](/checks/reference/rest/v1alpha/accounts.repos.scans)\n--------------------------------------------------------------------------------------------------\n\n| Methods ||\n|--------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [generate](/checks/reference/rest/v1alpha/accounts.repos.scans/generate) | `POST /v1alpha/{parent=accounts/*/repos/*}/scans:generate` Uploads the results of local Code Compliance analysis and generates a scan of privacy issues. |\n| [get](/checks/reference/rest/v1alpha/accounts.repos.scans/get) | `GET /v1alpha/{name=accounts/*/repos/*/scans/*}` Gets a repo scan. |\n| [list](/checks/reference/rest/v1alpha/accounts.repos.scans/list) | `GET /v1alpha/{parent=accounts/*/repos/*}/scans` Lists repo scans for the specified repo. |\n\nREST Resource: [v1alpha.aisafety](/checks/reference/rest/v1alpha/aisafety)\n--------------------------------------------------------------------------\n\n| Methods ||\n|----------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------|\n| [classifyContent](/checks/reference/rest/v1alpha/aisafety/classifyContent) | `POST /v1alpha/aisafety:classifyContent` Analyze a piece of content with the provided set of policies. |\n\nREST Resource: [v1alpha.media](/checks/reference/rest/v1alpha/media)\n--------------------------------------------------------------------\n\n| Methods ||\n|-------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [upload](/checks/reference/rest/v1alpha/media/upload) | `POST /v1alpha/{parent=accounts/*/apps/*}/reports:analyzeUpload` `POST /upload/v1alpha/{parent=accounts/*/apps/*}/reports:analyzeUpload` Analyzes the uploaded app bundle and returns a [google.longrunning.Operation](/checks/reference/rest/v1alpha/accounts.apps.operations#Operation) containing the generated [Report](/checks/reference/rest/v1alpha/accounts.apps.reports#Report). |"]]
