Method: accounts.repos.scans.get

AI-generated Key Takeaways

• The endpoint https://checks.googleapis.com/v1alpha/{name=accounts/*/repos/*/scans/*} is used to retrieve a repo scan using a GET request.

• The name path parameter is required and specifies the resource name of the repo scan.

• By default, only the name and resultsUri fields are returned, but additional fields can be included using the fields URL query parameter.

• The request body must be empty, and a successful response body contains an instance of RepoScan.

• The authorization scope https://www.googleapis.com/auth/checks is required to access this endpoint.

• HTTP request
• Path parameters
• Request body
• Response body
• Authorization scopes
• Try it!

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.