- Checkmarx Documentation
- Checkmarx SAST
- SAST API Guide
- CXSAST (REST) API
- CxSAST (REST) API v1.3
- Schemas
Schemas
Cx.ProjectManagement.Presentation.Dtos.GetGitSourceSettingsDto
{
"url": "string",
"branch": "string",
"useSsh": true,
"link": {
"rel": "string",
"uri": "string"
}
}
Properties
Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
url | string | false | read-only | The URL which is used to connect to GIT repository |
branch | string | false | read-only | The branch of a GIT repository |
useSsh | boolean | false | read-only | Specified whether a connection to GIT repository uses SSH protocol |
link | false | none | none |
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.ProjectManagement.Presentation.Dtos.GitSourceSettingsDtoV1_3
{
"url": "string",
"branch": "string",
"authentication": "Undefined",
"userName": "string",
"password": "string",
"pat": "string",
"privateKey": "string"
}
Properties
Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
url | string | true | none | The URL which is used to connect to GIT repository |
branch | string | true | none | The branch of a GIT repository |
authentication | string | false | none | The authentication method which is used to connect to a private GIT repository |
userName | string | false | none | The user name which is used to connect to GIT repository |
password | string | false | none | The user password which is used to connect to GIT repository |
pat | string | false | none | The user password which is used to connect to GIT repository |
privateKey | string | false | none | The private key which is used to connect to GIT repository using SSH protocol |
Enumerated Values
Property | Value |
|---|---|
authentication | Undefined |
authentication | none |
authentication | credentials |
authentication | PAT |
authentication | ssh |
Cx.ProjectManagement.Presentation.Dtos.GitSourceSettingsBaseDto
{
"url": "string",
"branch": "string"
}
Properties
Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
url | string | true | none | The URL which is used to connect to GIT repository |
branch | string | true | none | The branch of a GIT repository |
Cx.Sast.EngineServers.ApplicationContracts.DTOs.EngineServerResponse13Dto
{
"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",
"offlineReasonMessageParameters": "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 |
offlineReasonMessageParameters | 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.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 |