Skip to main content
Get a list of scans.
External DocumentationTo learn more, visit the Checkmarx One documentation.

​
Basic Parameters

ParameterDescription
BranchesA comma-separated list of branch names to filter results by.
GroupsA list of group IDs to filter results by, separated by the OR operator.

Note: Use an exact match.
InitiatorsA comma-separated list of user identifiers that initiated the scans to filter results by.
Project IDsA list of project IDs to filter results by, separated by the OR operator.
Return All PagesAutomatically fetch all resources, page by page.
Scan IDsA list of scan IDs to filter results by, separated by the OR operator.

Note: Use an exact match.
SortThe field to sort the results by.

* Use + for ascending order and - for descending order.
* The maximum number of fields to sort by is 3.
* Default: +created_at, +status.

​
Advanced Parameters

ParameterDescription
Correlation IDA unique identifier used to track a single request across multiple services.
From DateSpecify the start date and time from which to retrieve the results.
LimitThe maximum number of items to return per page.
OffsetThe offset of the item at which to begin the response.
Project NamesA comma-separated list of project names to filter results by.
SearchA partial-match string that is a substring of any scan parameter.
Source OriginsThe original triggering source of the scan to filter results by.
Source TypesThe code submission type to filter results by.
StatusesA list of scan statuses to filter results by.
Tags KeysA list of tag keys to filter results by, based on the assigned keys in key:value pairs, separated by the OR operator.
Tags ValuesA list of tag values to filter results by, based on the assigned values in the key:value pairs, separated by the OR operator.
To DateSpecify the end date and time until which to retrieve the results.

​
Example Output

{
	"totalCount": 2887,
	"filteredTotalCount": 2887,
	"scans": [
		{
			"id": "67cde54a-09c6-472f-87f4-1efd4a9f5dc4",
			"status": "Failed",
			"branch": "master",
			"createdAt": "2021-08-25T07:43:38.431606Z",
			"updatedAt": "2021-08-25T07:43:39.169448Z",
			"projectId": "3c8ea135-fc30-4fe7-b888-0e8a67d8c678",
			"projectName": "prod_test",
			"userAgent": "ASTCLI/2.0.0-rc.21",
			"initiator": "pedro",
			"tags": {},
			"metadata": {
				"id": "67cde54a-09c6-472f-87f4-1efd4a9f5dc4",
				"type": "git",
				"Handler": {
					"GitHandler": {
						"branch": "master",
						"repo_url": "https://github.com/pedrompflopes/ast-github-tester",
						"credentials": {
							"value": "*****",
							"username": "*****"
						}
					}
				},
				"configs": [
					{
						"type": "sast",
						"value": {
							"presetName": "Checkmarx Default",
							"incremental": "false"
						}
					},
					{
						"type": "kics"
					},
					{
						"type": "sca"
					}
				],
				"project": {
					"id": "3c8ea135-fc30-4fe7-b888-0e8a67d8c678"
				},
				"created_at": {
					"nanos": 381404397,
					"seconds": 1629877418
				}
			},
			"engines": null,
			"sourceType": "",
			"sourceOrigin": ""
		},
		{
			"id": "0d4293da-f407-4a25-8a24-d06ada1144b2",
			"status": "Completed",
			"branch": "main",
			"createdAt": "2021-08-25T07:44:21.491533Z",
			"updatedAt": "2021-08-25T07:44:57.283567Z",
			"projectId": "3c8ea135-fc30-4fe7-b888-0e8a67d8c678",
			"projectName": "prod_test",
			"userAgent": "ASTCLI/2.0.0-rc.21",
			"initiator": "pedro",
			"tags": {},
			"metadata": {
				"id": "0d4293da-f407-4a25-8a24-d06ada1144b2",
				"type": "git",
				"Handler": {
					"GitHandler": {
						"branch": "main",
						"repo_url": "https://github.com/pedrompflopes/ast-github-tester",
						"credentials": {
							"value": "*****",
							"username": "*****"
						}
					}
				},
				"configs": [
					{
						"type": "sast",
						"value": {
							"presetName": "Checkmarx Default",
							"incremental": "false"
						}
					},
					{
						"type": "kics"
					},
					{
						"type": "sca"
					}
				],
				"project": {
					"id": "3c8ea135-fc30-4fe7-b888-0e8a67d8c678"
				},
				"created_at": {
					"nanos": 448221189,
					"seconds": 1629877461
				}
			},
			"engines": null,
			"sourceType": "",
			"sourceOrigin": ""
		},
		{
			"id": "b4c5fdd3-a629-457a-8af0-95d7357ae35d",
			"status": "Completed",
			"branch": "main",
			"createdAt": "2021-08-25T07:49:56.94374Z",
			"updatedAt": "2021-08-25T07:50:34.580679Z",
			"projectId": "3c8ea135-fc30-4fe7-b888-0e8a67d8c678",
			"projectName": "prod_test",
			"userAgent": "ASTCLI/2.0.0-rc.21",
			"initiator": "pedro",
			"tags": {},
			"metadata": {
				"id": "b4c5fdd3-a629-457a-8af0-95d7357ae35d",
				"type": "git",
				"Handler": {
					"GitHandler": {
						"branch": "main",
						"repo_url": "https://github.com/pedrompflopes/ast-github-tester",
						"credentials": {
							"value": "*****",
							"username": "*****"
						}
					}
				},
				"configs": [
					{
						"type": "sast",
						"value": {
							"presetName": "Checkmarx Default",
							"incremental": "false"
						}
					},
					{
						"type": "kics"
					},
					{
						"type": "sca"
					}
				],
				"project": {
					"id": "3c8ea135-fc30-4fe7-b888-0e8a67d8c678"
				},
				"created_at": {
					"nanos": 883997904,
					"seconds": 1629877796
				}
			},
			"engines": null,
			"sourceType": "",
			"sourceOrigin": ""
		}
	]
}

​
Workflow Library Example

Retrieve List of Scans with Checkmarx One and Send Results Via Email
Workflow LibraryPreview this Workflow on desktop