Results Summary API
Introduction
These APIs enable you to get aggregated data about various types of vulnerabilities identified in the Projects in your account.
Notice
If you would like to get detailed info about individual vulnerabilities that were detected, use Scanners Results API.
Results Summary Endpoints
The URL for Results Summary Endpoints is <base_url>/api/scan-summary
Authentication
Authentication for all Checkmarx One endpoints is done using JWT (JSON Web Token) access token. Access tokens are generated using the Authentication API.
Summary of "Results Summary" Endpoints
The following is a list of Checkmarx One APIs that relate to Results Summary:
API | Method | Endpoint | Description |
|---|---|---|---|
GET Summary | GET | /api/scan-summary/ | Get summary of scan results for one or more scans. TipA separate summary is returned for each of the specified scans. |
The following is a list of Checkmarx One APIs that relate to Results Aggregation:
API | Method | Endpoint | Description |
|---|---|---|---|
GET SAST Aggregate | GET | /api/scan-summary/sast-aggregate | Get summary of aggregated SAST results for the specified scan. TipYou can customize the groupings and filters. An AND operator is applied between filters, and an OR operator is applied to multiple values for each filter. |
Swagger
To view these APIs in the Swagger UI and run sample API calls, go to <base_url>/spec/v1/ and select Results Summary in the definition field.