- Checkmarx Documentation
- Checkmarx SAST
- SAST API Guide
- CXSAST (REST) API
- CxSAST (REST) API v1.2
- Schemas
Schemas
Cx.Sast.ScanExecution.Presentation.Dtos.SastScansDtoV1_2
{
"id": 0,
"project": {
"id": 0,
"name": "string",
"link": {
"rel": "string",
"uri": "string"
}
},
"status": {
"id": 0,
"name": "string",
"details": {
"stage": "string",
"step": "string"
}
},
"scanType": "Unknown",
"comment": "string",
"dateAndTime": {
"startedOn": "2019-08-24T14:15:22Z",
"finishedOn": "2019-08-24T14:15:22Z",
"engineStartedOn": "2019-08-24T14:15:22Z",
"engineFinishedOn": "2019-08-24T14:15:22Z"
},
"resultsStatistics": {
"link": {
"rel": "string",
"uri": "string"
}
},
"scanState": {
"path": "string",
"sourceId": "string",
"filesCount": 0,
"linesOfCode": 0,
"failedLinesOfCode": 0,
"cxVersion": "string",
"languageStateCollection": [
{}
]
},
"owner": "string",
"origin": "string",
"originURL": "string",
"initiatorName": "string",
"owningTeamId": 0,
"isPublic": true,
"isLocked": true,
"isIncremental": true,
"scanRisk": 0,
"scanRiskSeverity": 0,
"engineServer": {
"id": 0,
"name": "string",
"link": {
"rel": "string",
"uri": "string"
}
},
"finishedScanStatus": "None",
"partialScanReasons": [
{
"abortedMessage": "string",
"abortedStatus": "None"
}
],
"customFields": {
"property1": "string",
"property2": "string"
}
}
Properties
Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
id | integer(int64) | false | none | none |
project | false | none | none | |
status | false | none | none | |
scanType | string | false | none | none |
comment | string | false | none | none |
dateAndTime | false | none | none | |
resultsStatistics | Cx.Sast.ScanExecution.Presentation.Dtos.ResultsStatisticsLink | false | none | none |
scanState | false | none | none | |
owner | string | false | none | none |
origin | string | false | none | none |
originURL | string | false | none | none |
initiatorName | string | false | none | none |
owningTeamId | integer(int32) | false | none | none |
isPublic | boolean | false | none | none |
isLocked | boolean | false | none | none |
isIncremental | boolean | false | none | none |
scanRisk | integer(int64) | false | none | none |
scanRiskSeverity | integer(int64) | false | none | none |
engineServer | false | none | none | |
finishedScanStatus | string | false | none | none |
partialScanReasons | false | none | none | |
customFields | object | false | none | none |
» additionalProperties | string | false | none | none |
Enumerated Values
Property | Value |
|---|---|
scanType | Unknown |
scanType | AllScans |
scanType | Regular |
scanType | Subset |
scanType | Partial |
scanType | Running |
finishedScanStatus | None |
finishedScanStatus | Completed |
finishedScanStatus | Partial |
Cx.Sast.ScanExecution.Presentation.Dtos.ProjectDto
{
"id": 0,
"name": "string",
"link": {
"rel": "string",
"uri": "string"
}
}
Properties
Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
id | integer(int64) | false | read-only | none |
name | string | false | read-only | none |
link | false | none | none |
Cx.Sast.ScanExecution.Presentation.Dtos.ScanStatusDto
{
"id": 0,
"name": "string",
"details": {
"stage": "string",
"step": "string"
}
}
Properties
Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
id | integer(int64) | false | read-only | none |
name | string | false | read-only | none |
details | Cx.Sast.ScanExecution.Presentation.Dtos.ScanStatusDetailsDto | false | none | none |
Cx.Sast.ScanExecution.Presentation.Dtos.DateAndTimeDto
{
"startedOn": "2019-08-24T14:15:22Z",
"finishedOn": "2019-08-24T14:15:22Z",
"engineStartedOn": "2019-08-24T14:15:22Z",
"engineFinishedOn": "2019-08-24T14:15:22Z"
}
Properties
Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
startedOn | string(date-time) | false | read-only | none |
finishedOn | string(date-time) | false | read-only | none |
engineStartedOn | string(date-time) | false | read-only | none |
engineFinishedOn | string(date-time) | false | read-only | none |
Cx.Sast.ScanExecution.Presentation.Dtos.ResultsStatisticsLink
{
"link": {
"rel": "string",
"uri": "string"
}
}
Properties
Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
link | false | none | none |
Cx.Sast.ScanExecution.Presentation.Dtos.ScanStateDto
{
"path": "string",
"sourceId": "string",
"filesCount": 0,
"linesOfCode": 0,
"failedLinesOfCode": 0,
"cxVersion": "string",
"languageStateCollection": [
{
"languageID": 0,
"languageName": "string",
"languageHash": "string",
"stateCreationDate": "2019-08-24T14:15:22Z"
}
]
}
Properties
Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
path | string | false | none | none |
sourceId | string | false | none | none |
filesCount | integer(int64) | false | none | none |
linesOfCode | integer(int64) | false | none | none |
failedLinesOfCode | integer(int64) | false | none | none |
cxVersion | string | false | none | none |
languageStateCollection | false | none | none |
Cx.Sast.ScanExecution.Presentation.Dtos.EngineServerDto
{
"id": 0,
"name": "string",
"link": {
"rel": "string",
"uri": "string"
}
}
Properties
Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
id | integer(int64) | false | none | none |
name | string | false | none | none |
link | false | none | none |
Cx.Sast.ScanExecution.Domain.Entities.PartialScanDTO
{
"abortedMessage": "string",
"abortedStatus": "None"
}
Properties
Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
abortedMessage | string | false | none | none |
abortedStatus | string | false | none | none |
Enumerated Values
Property | Value |
|---|---|
abortedStatus | None |
abortedStatus | Queries |
abortedStatus | Stages |
abortedStatus | QueriesExceededResultThreshold |
Cx.SuperTypes.API.Dtos.LinkDtoBase
{
"rel": "string",
"uri": "string"
}
Properties
Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
rel | string | false | read-only | none |
uri | string | false | read-only | none |
Cx.Sast.ScanExecution.Presentation.Dtos.ScanStatusDetailsDto
{
"stage": "string",
"step": "string"
}
Properties
Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
stage | string | false | read-only | none |
step | string | false | read-only | none |
Cx.Sast.ScanExecution.Domain.Entities.QueryLanguageState
{
"languageID": 0,
"languageName": "string",
"languageHash": "string",
"stateCreationDate": "2019-08-24T14:15:22Z"
}
Properties
Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
languageID | integer(int32) | false | none | none |
languageName | string | false | none | none |
languageHash | string | false | none | none |
stateCreationDate | string(date-time) | false | none | none |
Cx.Sast.EngineServers.ApplicationContracts.DTOs.EngineServerResponse12Dto
{
"id": 0,
"name": "string",
"uri": "string",
"minLoc": 0,
"maxLoc": 0,
"maxScans": 0,
"cxVersion": "string",
"operatingSystem": "string",
"status": "Offline",
"link": {
"rel": "string",
"uri": "string"
},
"offlineReasonCode": "Online",
"offlineReasonMessage": "string"
}
Properties
Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
id | integer(int64) | false | none | none |
name | string | false | none | none |
uri | string | false | none | none |
minLoc | integer(int32) | false | none | none |
maxLoc | integer(int32) | false | none | none |
maxScans | integer(int32) | false | none | none |
cxVersion | string | false | none | none |
operatingSystem | string | false | none | none |
status | string | false | none | none |
link | false | none | none | |
offlineReasonCode | string | false | none | none |
offlineReasonMessage | string | false | none | none |
Enumerated Values
Property | Value |
|---|---|
status | Offline |
status | Blocked |
status | ScanningAndBlocked |
status | Scanning |
status | Idle |
offlineReasonCode | Online |
offlineReasonCode | CannotAccess |
offlineReasonCode | EngineServerError |
offlineReasonCode | MessageQueueConfigurationIssue |
offlineReasonCode | OnlineButMessageQueueConfigurationValidatationError |
offlineReasonCode | ActiveMQConnectionError |
offlineReasonCode | EngineAndPackVersionMismtach |
offlineReasonCode | EngineDiskSpaceError |
Cx.Sast.EngineServers.ApplicationContracts.DTOs.EngineServerDTO
{
"name": "string",
"uri": "string",
"minLoc": 0,
"maxLoc": 0,
"isBlocked": true,
"maxScans": 0
}
Properties
Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
name | string | true | none | none |
uri | string | true | none | none |
minLoc | integer(int32) | true | none | none |
maxLoc | integer(int32) | true | none | none |
isBlocked | boolean | true | none | none |
maxScans | integer(int32) | false | none | none |
Cx.Sast.EngineServers.Presentation.Dtos.CreateEngineServerDto
{
"id": 0,
"link": {
"rel": "string",
"uri": "string"
}
}
Properties
Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
id | integer(int64) | false | none | none |
link | false | none | none |
Cx.Sast.ScanExecution.Presentation.Dtos.PatchScansQueue
{
"status": "Canceled"
}
Properties
Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
status | string | true | none | none |
Enumerated Values
Property | Value |
|---|---|
status | Empty |
status | Canceled |
status | Postponed |
Cx.SuperTypes.API.Dtos.LinkedResource
{
"id": 0,
"link": {
"rel": "string",
"uri": "string"
}
}
Properties
Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
id | integer(int64) | false | none | none |
link | false | none | none |
Cx.Sast.EngineServers.ApplicationContracts.Models.EngineServerPatchModel
{
"name": "string",
"uri": "string",
"minLoc": 0,
"maxLoc": 0,
"isBlocked": true,
"maxScans": 0
}
Properties
Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
name | string | false | none | Engine Server name |
uri | string | false | none | Engine Server Uri |
minLoc | integer(int32) | false | none | Minimum LinesOfCode for the server |
maxLoc | integer(int32) | false | none | Maximum LinesOfCode for the server |
isBlocked | boolean | false | none | Flag to determine if EngineServer is blocked |
maxScans | integer(int32) | false | none | Max concurrent scans |
Cx.Sast.ScanExecution.Presentation.Dtos.SastScanRequestV1_2DTO
{
"id": 0,
"stage": "New",
"teamId": "string",
"project": {
"id": 0,
"name": "string"
},
"engineId": 0,
"loc": 0,
"languages": [
{
"id": 0,
"name": "string"
}
],
"dateCreated": "2019-08-24T14:15:22Z",
"queuedOn": "2019-08-24T14:15:22Z",
"engineStartedOn": "2019-08-24T14:15:22Z",
"engineFinishedOn": "2019-08-24T14:15:22Z",
"isIncremental": true,
"isPublic": true,
"origin": "string"
}
Properties
Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
id | integer(int64) | false | none | none |
stage | string | false | none | none |
teamId | string | false | none | none |
project | false | none | none | |
engineId | integer(int64) | false | none | none |
loc | integer(int32) | false | none | none |
languages | false | none | none | |
dateCreated | string(date-time) | false | none | none |
queuedOn | string(date-time) | false | none | none |
engineStartedOn | string(date-time) | false | none | none |
engineFinishedOn | string(date-time) | false | none | none |
isIncremental | boolean | false | none | none |
isPublic | boolean | false | none | none |
origin | string | false | none | none |
Enumerated Values
Property | Value |
|---|---|
stage | New |
stage | PreScan |
stage | Queued |
stage | Scanning |
stage | PostScan |
stage | Finished |
stage | Canceled |
stage | Failed |
stage | SourcePullingAndDeployment |
stage | None |
Cx.Sast.ScanExecution.Presentation.Dtos.SastProjectV01DTO
{
"id": 0,
"name": "string"
}
Properties
Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
id | integer(int64) | false | read-only | none |
name | string | false | read-only | none |
Cx.Sast.ScanExecution.Domain.ValueObjects.ProgramLanguage
{
"id": 0,
"name": "string"
}
Properties
Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
id | integer(int64) | false | none | none |
name | string | false | none | none |
Cx.Sast.ScanExecution.ApplicationContracts.DTOs.SastScanRequestWriteDTO
{
"projectId": 1,
"isIncremental": false,
"isPublic": true,
"forceScan": true,
"comment": "",
"customFields": {
"key": "value"
}
}
Properties
Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
projectId | integer(int64) | true | none | Specifies the Unique Id of the specific project to be scanned |
isIncremental | boolean | false | none | Specifies whether the scan is incremental of full |
isPublic | boolean | false | none | Specifies whether the requested scan is public or private |
forceScan | boolean | false | none | Specifies whether the code should be scanned regardless of unchanged code |
comment | string | false | none | Specifies the scan comment |
customFields | object | false | none | none |
» additionalProperties | string | false | none | none |
Cx.ProjectManagement.Presentation.Dtos.ScanSettingsExtRequestV1_2Dto
{
"projectId": 1,
"overrideProjectSetting": true,
"isIncremental": true,
"isPublic": true,
"forceScan": true,
"comment": "string",
"presetId": 0,
"engineConfigurationId": 0,
"customFields": "string",
"postScanActionId": 0
}
Properties
Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
projectId | integer(int64) | true | none | Specifies the Unique Id of the specific project to be scanned |
overrideProjectSetting | boolean | false | none | Specifies whether to overwrite project settings to be the default for the next scans .If set to false or empty - do not overwrite project settings. If set to true - overwrite project settings |
isIncremental | boolean | false | none | Specifies whether the scan is incremental of full |
isPublic | boolean | false | none | Specifies whether the requested scan is public or private |
forceScan | boolean | false | none | Specifies whether the code should be scanned regardless of unchanged code |
comment | string | false | none | Specifies the scan comment |
presetId | integer(int64) | false | none | Specify the preset id to use during the scan, 0 = use project’s default |
engineConfigurationId | integer(int64) | false | none | Specify the engine-configuration to use during the scan, 0 = use project’s default |
customFields | string | false | none | Any custom fields used to tag the scan. Example: {“key1”:“val1”,“key2”:“val2”} |
postScanActionId | integer(int64) | false | none | Specify post action to be executed after scan is completed |
Cx.CrossCutting.FileSystem.Files.CxFile_System.ByteArray_
{
"name": "string",
"content": "string"
}
Properties
Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
name | string | false | none | none |
content | string(byte) | false | none | none |