Checkmarx SCA (REST) API - Export Service

This API enables you to export reports of the data identified by a Checkmarx SCA scan.

Currently, this API supports generating Software Bill of Materials (SBOM) reports. SBOMs can be generated in either CycloneDX v1.4 or SPDX v2.2 format. SPDX SBOMs are output in JSON format. For CycloneDX, there is an option to output the data as JSON or XML.

This endpoint is used to generate a report for a specific scan by specifying the scanId and the desired report format.

{
    "ScanId": "fbd46412-0227-44ef-9feb-8464273a1234",
    "FileFormat": "CycloneDxJson"
}

curl --location --request POST 'https://api.scacheckmarx.com/export/requests' \
--header 'Authorization: Bearer {TOKEN}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "ScanId": "fbd46412-0227-44ef-9feb-8464273a1234",
    "FileFormat": "CycloneDxXml"}'

{
    "exportId": "2d46cf11-a77c-4333-922a-b3bc33581234"
}

This endpoint is used to check the status of a specific report. Once the report is completed, this endpoint also returns the Url to be used for downloading the report.

{
    "exportId": "2d46cf11-a77c-4333-922a-b3bc33581234"
}

curl --location --request GET 'https://api.scacheckmarx.com/export/requests?exportId=e537bcb0-e539-4a6b-9881-43cb2ea21234' \
--header 'Authorization: Bearer {TOKEN}'

{
    "exportId": "2d46cf11-a77c-4333-922a-b3bc33586060",
    "exportStatus": "Completed",
    "fileUrl": "https://mysbom.json"
}