Method: accounts.repos.scans.get
Stay organized with collections
Save and categorize content based on your preferences.
Gets a repo scan.
By default, only the name and resultsUri fields are returned. You can include other fields by listing them in the fields URL query parameter. For example, ?fields=name,sources will return the name and sources fields.
HTTP request
GET https://checks.googleapis.com/v1alpha/{name=accounts/*/repos/*/scans/*}
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
name |
string
Required. Resource name of the repo scan. Example: accounts/123/repos/456/scans/789
|
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of RepoScan.
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\u003eRetrieves detailed information about a specific repository scan using a \u003ccode\u003eGET\u003c/code\u003e request.\u003c/p\u003e\n"],["\u003cp\u003eThe response includes scan details, and you can specify desired fields using the \u003ccode\u003efields\u003c/code\u003e query parameter.\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\u003eIdentifies the repository scan using a resource name in the URL path.\u003c/p\u003e\n"]]],[],null,["# Method: accounts.repos.scans.get\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nGets a repo scan.\n\nBy default, only the [name](/checks/reference/rest/v1alpha/accounts.repos.scans#RepoScan.FIELDS.name) and [resultsUri](/checks/reference/rest/v1alpha/accounts.repos.scans#RepoScan.FIELDS.results_uri) fields are returned. You can include other fields by listing them in the `fields` URL query parameter. For example, `?fields=name,sources` will return the [name](/checks/reference/rest/v1alpha/accounts.repos.scans#RepoScan.FIELDS.name) and [sources](/checks/reference/rest/v1alpha/accounts.repos.scans#RepoScan.FIELDS.sources) fields.\n\n### HTTP request\n\n`GET https://checks.googleapis.com/v1alpha/{name=accounts/*/repos/*/scans/*}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------|------------------------------------------------------------------------------------------------|\n| `name` | `string` Required. Resource name of the repo scan. Example: `accounts/123/repos/456/scans/789` |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains an instance of [RepoScan](/checks/reference/rest/v1alpha/accounts.repos.scans#RepoScan).\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)."]]
