New Data Retention Policy
We will be changing our customer data retention policy in order to enhance data security, improve compliance and performance, and reduce risk across our platform.
The following data retention rules will be implemented:
Results data (e.g., scan results, findings metadata, and analysis logs) will be retained for 3 months. For customers with Premium Support, the retention period will be extended to 12 months.
Source code (e.g., uploaded or ingested code/packages used during scan analysis) will be retained for a period of 30 days.
This article explains how you can export your scan results using the Checkmarx One web application (UI) or the available APIs.
Notice
This article relates to exporting data from Checkmarx One. A similar retention policy is also being impemented for SCA standalone, see SCA documentation.
Exporting Data from Checkmarx One via Web Application
If you need to retain data (e.g., evidence packs, historical reports) beyond the scheduled time period, you should download reports that contain the relevant data.
For detailed information about various types of scan reports and how they can be exported, see Scan Reports.
The following procedure explains how you can easily download a "default" scan report.
In Checkmarx One, navigate to the left side panel and select Projects.
Select the project you want to export the scan results from and go to the overview page by selecting
.Navigate to the Scan History tab.
At the end of the scan's row, click
then Generate Default Report .Once the report is ready, a notification will appear that it is available for downloading. Click Download report to download it.
Exporting Data via API
You can use our APIs to export scan reports or to export lists of results (risks) identified by each scanner.
Exporting Scan Reports via API
The following workflow explains how you can use our (REST) APIs to export scan reports.
Use the Scans API (GET {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.
Once the scan and project IDs are returned, they can be used with the Reports API, Create a report (POST {Base_URL}/api/reports/v2 ) endpoint to generate a report.
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 (GET {Base_URL}/api/reports/{reportId} ) endpoint. The status of a report can be: Requested, Started, Completed, or Failed.
To download the report use the Download a report (GET {Base_URL}/api/reports/{reportId}/download ) endpoint.
Exporting Scanner Results via API
Use the Scans API (GET {Base_URL}/api/scans/ ) endpoint to obtain the list of scans and project IDs to generate the reports.
After obtaining the scan IDs, the Scanners Results API (GET {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.