Method: accounts.repos.scans.list
Stay organized with collections
Save and categorize content based on your preferences.
Lists repo scans for the specified repo.
HTTP request
GET https://checks.googleapis.com/v1alpha/{parent=accounts/*/repos/*}/scans
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
parent |
string
Required. Resource name of the repo. Example: accounts/123/repos/456
|
Query parameters
| Parameters |
pageSize |
integer
Optional. The maximum number of repo scans to return. If unspecified, at most 10 repo scans will be returned. The maximum value is 50; values above 50 will be coerced to 50.
|
pageToken |
string
Optional. A page token received from a previous scans.list call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to scans.list must match the call that provided the page token.
|
filter |
string
Optional. An AIP-160 filter string to filter repo scans. Example: scmMetadata.branch = main
|
Request body
The request body must be empty.
Response body
The response message for RepoScanService.ListRepoScans.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"repoScans": [
{
object (RepoScan)
}
],
"nextPageToken": string
} |
| Fields |
repoScans[] |
object (RepoScan)
The repo scans for the specified app.
|
nextPageToken |
string
A token which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.
|
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/checks
For more information, see the OAuth 2.0 Overview.
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\u003eLists repository scans for a specified repository using the provided \u003ccode\u003eparent\u003c/code\u003e path parameter.\u003c/p\u003e\n"],["\u003cp\u003eAllows filtering, pagination, and limiting the number of results returned using query parameters.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/checks\u003c/code\u003e scope.\u003c/p\u003e\n"],["\u003cp\u003eReturns a list of repository scans with details and a pagination token for accessing further results.\u003c/p\u003e\n"],["\u003cp\u003eThe request body should be empty, and the response body contains a JSON representation of the repo scans and pagination details.\u003c/p\u003e\n"]]],[],null,["# Method: accounts.repos.scans.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListRepoScansResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists repo scans for the specified repo.\n\n### HTTP request\n\n`GET https://checks.googleapis.com/v1alpha/{parent=accounts/*/repos/*}/scans`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|---------------------------------------------------------------------------------|\n| `parent` | `string` Required. Resource name of the repo. Example: `accounts/123/repos/456` |\n\n### Query parameters\n\n| Parameters ||\n|---------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `page``Size` | `integer` Optional. The maximum number of repo scans to return. If unspecified, at most 10 repo scans will be returned. The maximum value is 50; values above 50 will be coerced to 50. |\n| `page``Token` | `string` Optional. A page token received from a previous `scans.list` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `scans.list` must match the call that provided the page token. |\n| `filter` | `string` Optional. An [AIP-160](https://google.aip.dev/160) filter string to filter repo scans. Example: `scmMetadata.branch = main` |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nThe response message for [RepoScanService.ListRepoScans](/checks/reference/rest/v1alpha/accounts.repos.scans/list#google.checks.repo.scan.v1alpha.RepoScanService.ListRepoScans).\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"repoScans\": [ { object (/checks/reference/rest/v1alpha/accounts.repos.scans#RepoScan) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|---------------------|---------------------------------------------------------------------------------------------------------------------------------------|\n| `repo``Scans[]` | `object (`[RepoScan](/checks/reference/rest/v1alpha/accounts.repos.scans#RepoScan)`)` The repo scans for the specified app. |\n| `next``Page``Token` | `string` A token which can be sent as `pageToken` to retrieve the next page. If this field is omitted, there are no subsequent pages. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/checks`\n\nFor more information, see the [OAuth 2.0 Overview](https://developers.google.com/identity/protocols/OAuth2)."]]
