To learn more, visit the Checkmarx One documentation.

​
Basic Parameters​

ParameterDescription
Return All PagesAutomatically fetch all resources, page by page.
Scan IDThe scan ID. Only exact matches are returned. You can obtain this ID by running the Retrieve List Of Scans action.
SortSort results by the specified parameter. The operators ’+/-’ are for ascending/descending order, followed by the parameter.Note you can only sort by maximun 3 values from the following options:- -severity
  • +severity
  • -status
  • +status
  • -state
  • +state
  • -type
  • +type
  • -firstfoundat
  • +firstfoundat
  • -foundat
  • +foundat
  • -firstscanid
  • +firstscanid |

​
Advanced Parameters​

ParameterDescription
LimitThe maximum number of results to return.default_value: 20
OffsetThe offset of the returned results.

​
Example Output​

{    "results": [        {            "comments": {},            "confidenceLevel": 0,            "created": "2024-06-19T07:54:21Z",            "data": {                "expectedValue": "After using apt-get install, the apt-get lists should be deleted",                "fileName": "/path/to/Dockerfile",                "group": "Supply-Chain",                "issueType": "IncorrectValue",                "line": 12,                "platform": "Dockerfile",                "queryId": "query-id-placeholder-001",                "queryName": "Apt Get Install Lists Were Not Deleted",                "queryUrl": "Query URL Placeholder",                "value": "After using apt-get install, the apt-get lists were not deleted"            },            "description": "After using apt-get install, it is needed to delete apt-get lists",            "firstFoundAt": "2024-06-13T08:19:54Z",            "firstScanId": "scan-id-placeholder-001",            "foundAt": "2024-06-19T07:54:21Z",            "id": "unique-id-001",            "severity": "INFO",            "similarityId": "similarity-hash-placeholder-001",            "state": "TO_VERIFY",            "status": "RECURRENT",            "type": "kics",            "vulnerabilityDetails": {}        },        {            "comments": {},            "confidenceLevel": 0,            "created": "2024-06-19T07:54:21Z",            "data": {                "expectedValue": "Expected command structure with '--no-install-recommends'",                "fileName": "/path/to/Dockerfile",                "group": "Supply-Chain",                "issueType": "IncorrectValue",                "line": 12,                "platform": "Dockerfile",                "queryId": "query-id-placeholder-002",                "queryName": "APT-GET Not Avoiding Additional Packages",                "queryUrl": "Query URL Placeholder",                "value": "Actual command structure without '--no-install-recommends'"            },            "description": "Check if any apt-get installs don't use '--no-install-recommends' flag to avoid installing additional packages.",            "firstFoundAt": "2024-06-13T08:19:54Z",            "firstScanId": "scan-id-placeholder-002",            "foundAt": "2024-06-19T07:54:21Z",            "id": "unique-id-002",            "severity": "INFO",            "similarityId": "similarity-hash-placeholder-002",            "state": "TO_VERIFY",            "status": "RECURRENT",            "type": "kics",            "vulnerabilityDetails": {}        },        {            "comments": {},            "confidenceLevel": 0,            "created": "2024-06-19T07:57:40Z",            "data": {                "group": "Java_Low_Visibility",                "languageName": "Java",                "nodes": [                    {                        "definitions": "1",                        "domType": "UnknownReference",                        "fileName": "/path/to/config/file",                        "fullName": "Namespace.ApplicationResources.show-password",                        "id": "node-id-placeholder",                        "length": 13,                        "line": 4,                        "method": "ApplicationResources",                        "methodLine": 1,                        "name": "show-password",                        "nodeID": 149399,                        "typeName": "object"                    }                ],                "queryId": "query-id-placeholder-003",                "queryName": "Use_Of_Hardcoded_Password_In_Config",                "resultHash": "result-hash-placeholder"            },            "description": "The configuration file contains a hardcoded password",            "firstFoundAt": "2024-06-13T08:23:36Z",            "firstScanId": "scan-id-placeholder-003",            "foundAt": "2024-06-19T07:57:40Z",            "id": "unique-id-003",            "severity": "LOW",            "similarityId": "similarity-hash-placeholder-003",            "state": "TO_VERIFY",            "status": "RECURRENT",            "type": "sast",            "vulnerabilityDetails": {                "compliances": [                    "CWE top 25",                    "OWASP ASVS",                    "OWASP Top 10 2021",                    "OWASP Top 10 API",                    "PCI DSS v4.0",                    "Base Preset"                ],                "cweId": 260            }        }    ],    "totalCount": 676}

​
Workflow Library Example​

Retrieve Scan Results for All Scanners with Checkmarx One and Send Results Via Email

Preview this Workflow on desktop

Was this page helpful?

Retrieve Scan DetailsRetrieve Scan Status Summary