Skip to main content

Exporting Results Data from Checkmarx One and Checkmarx SCA Standalone

The following step-by-step guide explains how to export your scan results using the application or the available APIs.

Exporting Data from Checkmarx One

  1. In Checkmarx One, navigate to the left side panel and select Projects.

  2. Select the project you want to export the scan results from and go to the overview page by selecting pie_icon.png.

  3. Navigate to the Scan History tab.

  4. At the end of the scan's row, click Vertical_Ellipsis.png then Generate Default Report .

  5. Once the report is ready, a notification will appear that it is available for downloading. Click Download report to download it.

Exporting Scan Reports Using the API

  1. Use the Scans API ( {Base_URL}/api/scans/ ) endpoint to obtain the list of scans and project IDs to generate the reports.

    Note

    This endpoint allows Checkmarx to pass different parameters as filters (e.g., branch, from-date, to-date, etc.). The full list of parameters can be found here. By default, the maximum number of results to return is 20; it’s possible to change this by altering the limit parameter.

  2. Once the scan and project IDs are returned, they can be used with the Reports API, Create a report ( {Base_URL}/api/reports/ ) endpoint to generate a report. The scan and project IDs are mandatory.

  3. After the request for a new report is completed, the report may take a couple of seconds to become ready for download. The report status can be checked by using the Retrieve report status ( {Base_URL}/api/reports/{reportId} ) endpoint. The status of a report can be: Requested, Started, Completed, or Failed.

  4. To download the report the Download a report ( {Base_URL}/api/reports/{reportId}/download ) endpoint should be used.

Obtaining a List of Results Using the API

  1. Use the Scans API ( {Base_URL}/api/scans/ ) endpoint to obtain the list of scans and project IDs to generate the reports.

  2. After obtaining the scan IDs the Scanners Results API ( {Base_URL}/api/results/ ) can be used to obtain the results for each scanner. By default, the maximum number of results to return is 20, it’s possible to change this by altering the limit parameter.

Exporting Data from SCA Standalone

The following base URLs are used for all calls, depending on your environment:

  • US Environment - https://api-sca.checkmarx.net

  • EU Environment - https://eu.api-sca.checkmarx.net

  1. Use the Projects API ( {Base_URL}/risk-management/projects/ ) to obtain information about all the Projects in your account, the projectId is necessary for the next step.

  2. Use the obtained projectId to obtain information about the scans on each project using the Scans API ( {Base_URL}/risk-management/scans/ ) endpoint to obtain all the scanId from each project. By default, up to 10 results are returned. You can adjust this limit and apply pagination using the size and page parameters.

  3. The scanId obtained can be used with the Export Service API to generate a Scan Report that shows an overview of the security of your project as well as specific vulnerabilities, legal risks, and outdated versions identified by the scan. Scan Reports can be generated in JSON, XML, PDF or CSV format.

    Create a report using the (POST) /requests endpoint and specify the scanId and the fileFormat. Once the request is created you can check its status by using the (GET) /requests endpoint to check the status of a specific report. More information on the Export Endpoints can be found here.

In this section: