- Checkmarx Documentation
- Checkmarx One
- Checkmarx One API Documentation
- Checkmarx One API Endpoints
- Results Summary API
Results Summary API
Notice
A comprehensive Checkmarx One API Reference Guide is now available here.
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
US Environment - https://ast.checkmarx.net
US2 Environment - https://us.ast.checkmarx.net
EU Environment - https://eu.ast.checkmarx.net
EU2 Environment - https://eu-2.iam.checkmarx.net/
Australia & New Zealand – https://anz.ast.checkmarx.net
India - https://ind.ast.checkmarx.net
Singapore - https://sng.ast.checkmarx.net
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.
US Environment - https://ast.checkmarx.net/spec/v1/
US2 Environment - https://us.ast.checkmarx.net/spec/v1/
EU Environment - https://eu.ast.checkmarx.net/spec/v1/
EU2 Envitonment - https://eu-2.ast.checkmarx.net/spec/v1/
Australia & New Zealand – https://anz.ast.checkmarx.net/spec/v1/
Singapore - https://sng.ast.checkmarx.net/spec/v1/