Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14139565.0 KB

Returns details about a scan, including whether or not a scan has completed.

get/scans/{scanName}

Path parameters

scanNamestring required

The name of the scan you want to view details about.

Query parameters

runIdstring

UUID that identifies the individual scan run you want to view details about. You retrieve this when you call the <code>CreateScan</code> operation. Defaults to the latest scan run if missing.

Response

Success

scanNamestring required

The name of the scan.

runIdstring required

UUID that identifies the individual scan run.

scanState'InProgress' | 'Successful' | 'Failed' required

The current state of the scan. Returns either <code>InProgress</code>, <code>Successful</code>, or <code>Failed</code>.

createdAtstring date-time required

The time the scan was created.

analysisType'Security' | 'All' required

The type of analysis CodeGuru Security performed in the scan, either <code>Security</code> or <code>All</code>. The <code>Security</code> type only generates findings related to security. The <code>All</code> type generates both security findings and quality findings.

updatedAtstring date-time

The time when the scan was last updated. Only available for <code>STANDARD</code> scan types.

numberOfRevisionsinteger

The number of times a scan has been re-run on a revised resource.

scanNameArnstring

The ARN for the scan name.

errorMessagestring

Details about the error that causes a scan to fail to be retrieved.