Skip to main content
Get details and the current status of a specific scan.
External DocumentationTo learn more, visit the Checkmarx One documentation.

​
Parameters

ParameterDescription
Correlation IDA unique identifier used to track a single request across multiple services.
Scan IDThe ID of the specific scan to get details for.

​
Example Output

{
	"id": "scan-id-001",
	"status": "Completed",
	"statusDetails": [
		{
			"name": "general",
			"status": "Completed",
			"details": "",
			"startDate": "2024-06-19T00:00:00Z",
			"endDate": "2024-06-19T00:01:00Z"
		},
		{
			"name": "sast",
			"status": "Completed",
			"details": "",
			"loc": 80623,
			"startDate": "2024-06-19T07:54:16Z",
			"endDate": "2024-06-19T07:57:52Z"
		},
		{
			"name": "sca",
			"status": "Completed",
			"details": "",
			"startDate": "2024-06-19T07:54:16Z",
			"endDate": "2024-06-19T08:00:36Z"
		},
		{
			"name": "kics",
			"status": "Completed",
			"details": "",
			"startDate": "2024-06-19T07:54:16Z",
			"endDate": "2024-06-19T07:54:22Z"
		},
		{
			"name": "apisec",
			"status": "Completed",
			"details": "",
			"startDate": "2024-06-19T07:57:52Z",
			"endDate": "2024-06-19T07:57:53Z"
		}
	],
	"branch": "main",
	"createdAt": "2024-06-19T07:54:11Z",
	"updatedAt": "2024-06-19T08:00:36Z",
	"projectId": "project-id-002",
	"projectName": "Demo-Organization/demo-repo",
	"userAgent": "grpc-java-netty/1.63.0",
	"initiator": "demoUser",
	"tags": {},
	"metadata": {
		"id": "metadata-id-003",
		"type": "git",
		"Handler": {
			"GitHandler": {
				"branch": "main",
				"repo_url": "https://github.com/Demo-Organization/demo-repo",
				"credentials": {
					"type": "apiKey",
					"value": "api-key-placeholder",
					"username": "username-placeholder"
				}
			}
		},
		"configs": [
			{
				"type": "sast",
				"value": {
					"presetName": "default",
					"incremental": "false"
				}
			},
			{
				"type": "sca"
			},
			{
				"type": "kics"
			},
			{
				"type": "apisec"
			}
		],
		"project": {
			"id": "project-id-002"
		},
		"created_at": {
			"nanos": 123456789,
			"seconds": 987654321
		}
	},
	"engines": [
		"sast",
		"sca",
		"kics",
		"apisec"
	],
	"sourceType": "github",
	"sourceOrigin": "Push Webhook"
}

​
Workflow Library Example

Retrieve Scan Details with Checkmarx One and Send Results Via Email
Workflow LibraryPreview this Workflow on desktop