- Checkmarx Documentation
- Checkmarx SAST
- SAST API Guide
- CXSAST (REST) API
- CxSAST (REST) API v2
- Schemas
Schemas
Cx.ProjectManagement.Presentation.Dtos.ProjectBaseDtoV2WithOwner
{
"id": 0,
"teamId": 0,
"owner": "string",
"name": "string",
"isPublic": true,
"customFields": [
{
"id": 0,
"value": "string",
"name": "string"
}
],
"links": [
{
"rel": "string",
"uri": "string"
}
]
}
Properties
Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
id | integer(int64) | false | read-only | none |
teamId | integer(int32) | false | read-only | none |
owner | string | false | read-only | none |
name | string | false | read-only | none |
isPublic | boolean | false | read-only | none |
customFields | [Cx.ProjectManagement.Domain.ValueObjects.ProjectCustomField] | false | read-only | none |
links | false | none | none |
Cx.ProjectManagement.Domain.ValueObjects.ProjectCustomField
{
"id": 0,
"value": "string",
"name": "string"
}
Properties
Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
id | integer(int64) | false | none | none |
value | string | false | none | none |
name | string | 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.UpdateFullProjectDto
{
"name": "string",
"owningTeam": 0,
"customFields": [
{
"id": 0,
"value": "string"
}
]
}
Properties
Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
name | string | true | none | Specifies the name of the project |
owningTeam | integer(int32) | true | none | Specifies the team id which owns the project |
customFields | [Cx.ProjectManagement.Presentation.Dtos.UpdateCustomFieldDto] | true | none | Specifies the custom fields in a project |
Cx.ProjectManagement.Presentation.Dtos.UpdateCustomFieldDto
{
"id": 0,
"value": "string"
}
Properties
Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
id | integer(int64) | false | none | none |
value | string | false | none | none |
Cx.ProjectManagement.Presentation.Dtos.UpdateProjectDto
{
"name": "SomeProject",
"owningTeam": 12345678
}
Properties
Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
name | string | false | none | Specifies the name of the project |
owningTeam | integer(int32) | false | none | Specifies the team id which owns the project |
Cx.ProjectManagement.Presentation.Dtos.DeleteProjectDto
{
"deleteRunningScans": true
}
Properties
Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
deleteRunningScans | boolean | false | none | Specifies whether the running scans must be deleted |
Cx.ProjectManagement.Presentation.Dtos.ProjectBaseDtoV2
{
"id": 0,
"teamId": 0,
"name": "string",
"isPublic": true,
"customFields": [
{
"id": 0,
"value": "string",
"name": "string"
}
],
"links": [
{
"rel": "string",
"uri": "string"
}
]
}
Properties
Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
id | integer(int64) | false | read-only | none |
teamId | integer(int32) | false | read-only | none |
name | string | false | read-only | none |
isPublic | boolean | false | read-only | none |
customFields | [Cx.ProjectManagement.Domain.ValueObjects.ProjectCustomField] | false | read-only | none |
links | false | none | none |
Cx.ProjectManagement.Presentation.Dtos.SaveProjectDto
{
"name": "SomeProject",
"owningTeam": "1",
"isPublic": true
}
Properties
Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
name | string | false | none | Specifies the name of the project |
owningTeam | string | true | none | Specifies the team id which owns the project |
isPublic | boolean | true | none | Specifies whether the project public or not |
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.Osa.Application.DTOs.Responses.ScanDtoV2
{
"findingsStatus": "string",
"id": "00000000-0000-0000-0000-000000000000",
"startAnalyzeTime": "2019-08-24T14:15:22Z",
"endAnalyzeTime": "2019-08-24T14:15:22Z",
"origin": "string",
"sourceCodeOrigin": "string",
"state": {
"id": 0,
"name": "string",
"failureReason": "string"
},
"sharedSourceLocationPaths": [
"string"
]
}
Properties
Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
findingsStatus | string | false | none | none |
id | string(uuid) | false | none | none |
startAnalyzeTime | string(date-time) | false | none | none |
endAnalyzeTime | string(date-time) | false | none | none |
origin | string | false | none | none |
sourceCodeOrigin | string | false | none | none |
state | false | none | none | |
sharedSourceLocationPaths | [string] | false | none | none |
Cx.Osa.Application.DTOs.StateDTO
{
"id": 0,
"name": "string",
"failureReason": "string"
}
Properties
Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
id | integer(int32) | false | none | none |
name | string | false | none | none |
failureReason | string | false | none | none |
Cx.Osa.Application.DTOs.Responses.V2.ScannedLibraryDTO
{
"id": "string",
"name": "string",
"version": "string",
"releaseDate": "2019-08-24T14:15:22Z",
"highUniqueVulnerabilityCount": 0,
"mediumUniqueVulnerabilityCount": 0,
"lowUniqueVulnerabilityCount": 0,
"notExploitableVulnerabilityCount": 0,
"newestVersion": "string",
"newestVersionReleaseDate": "2019-08-24T14:15:22Z",
"numberOfVersionsSinceLastUpdate": 0,
"confidenceLevel": 0,
"matchType": {
"id": 0,
"name": "string",
"description": "string"
},
"licenses": [
"string"
],
"outdated": true,
"severity": {
"id": 0,
"name": "string"
},
"riskScore": 0,
"locations": [
{
"path": "string",
"matchType": {}
}
]
}
Library DTO
Properties
Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
id | string | false | none | Library ID |
name | string | false | none | Library Name |
version | string | false | none | Library Version |
releaseDate | string(date-time) | false | none | Library Release date of the current version |
highUniqueVulnerabilityCount | integer(int32) | false | none | Number of high vulnerabilities |
mediumUniqueVulnerabilityCount | integer(int32) | false | none | Number of medium vulnerabilities |
lowUniqueVulnerabilityCount | integer(int32) | false | none | Number of low vulnerabilities |
notExploitableVulnerabilityCount | integer(int32) | false | none | Number of not exploitable vulnerabilities |
newestVersion | string | false | none | Newest version (if no newest version exists, then this field will remain empty) |
newestVersionReleaseDate | string(date-time) | false | none | Release date of newest version (if no newest version exists, then this field will contain 1970/1/1) |
numberOfVersionsSinceLastUpdate | integer(int32) | false | none | Number of newer versions (if no newest version exists, then this field will be 0) |
confidenceLevel | integer(int32) | false | none | The confidence level about the provided result |
matchType | false | none | none | |
licenses | [string] | false | none | Collection of legal licenses id |
outdated | boolean | false | none | Indicate whether this library outdated |
severity | false | none | none | |
riskScore | number(double) | false | none | Library risk score based on highest vulnerability risk score |
locations | false | none | Library locations and their match-type |
Cx.Osa.Application.DTOs.MatchTypeDto
{
"id": 0,
"name": "string",
"description": "string"
}
Properties
Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
id | integer(int32) | false | read-only | none |
name | string | false | read-only | none |
description | string | false | read-only | none |
Cx.Osa.Application.DTOs.SeverityDTO
{
"id": 0,
"name": "string"
}
Properties
Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
id | integer(int32) | false | none | none |
name | string | false | none | none |
Cx.Osa.Application.DTOs.Responses.LibraryLocationDto
{
"path": "string",
"matchType": {
"id": 0,
"name": "string",
"description": "string"
}
}
Properties
Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
path | string | false | read-only | none |
matchType | false | none | none |
Cx.Osa.Presentation.DTOs.NewDTOs.ScanRequestInfo
{
"projectId": 1,
"origin": "string",
"hashedFilesList": [
{
"sha1": "string",
"filename": "string"
}
]
}
Scan request details
Properties
Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
projectId | integer(int64) | false | none | The Project Id associated with requested scan |
origin | string | false | none | The location from which scan was requested (if not specified (Portal) will be selected) |
hashedFilesList | false | none | none |
Cx.Osa.Presentation.DTOs.NewDTOs.HashedFileDTO
{
"sha1": "string",
"filename": "string"
}
Properties
Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
sha1 | string | false | none | none |
filename | string | false | none | none |
Cx.Osa.Presentation.DTOs.NewDTOs.NewScanResponseDTO
{
"scanId": "00000000-0000-0000-0000-000000000000"
}
Properties
Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
scanId | string(uuid) | true | none | none |
Cx.Osa.Application.DTOs.Responses.V2.VulnerabilityDto
{
"id": "string",
"cveName": "string",
"score": 0,
"severity": {
"id": 0,
"name": "string"
},
"publishDate": "2019-08-24T14:15:22Z",
"url": "string",
"description": "string",
"recommendations": "string",
"sourceFileName": "string",
"libraryId": "string",
"state": {
"id": 0,
"actionType": "string",
"name": "string"
},
"commentsAmount": 0,
"similarityId": "string",
"fixUrl": "string"
}
Properties
Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
id | string | false | none | none |
cveName | string | false | none | none |
score | number(float) | false | none | none |
severity | false | none | none | |
publishDate | string(date-time) | false | none | none |
url | string | false | none | none |
description | string | false | none | none |
recommendations | string | false | none | none |
sourceFileName | string | false | none | none |
libraryId | string | false | none | none |
state | false | none | none | |
commentsAmount | integer(int32) | false | none | none |
similarityId | string | false | none | none |
fixUrl | string | false | none | none |
Cx.Osa.Application.DTOs.Responses.VulnerabilityStateDto
{
"id": 0,
"actionType": "string",
"name": "string"
}
Properties
Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
id | integer(int32) | false | read-only | none |
actionType | string | false | read-only | none |
name | string | false | read-only | none |
Cx.Sast.ScanSettings.Presentation.Dtos.ScanSettingsResponseDtoV2
{
"project": {
"id": 0,
"link": {
"rel": "string",
"uri": "string"
}
},
"preset": {
"id": 0,
"link": {
"rel": "string",
"uri": "string"
}
},
"engineConfiguration": {
"id": 0,
"link": {
"rel": "string",
"uri": "string"
}
},
"postScanActionData": "string",
"postScanActionName": "string",
"emailNotifications": {
"failedScan": [
"string"
],
"beforeScan": [
"string"
],
"afterScan": [
"string"
]
}
}
Properties
Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
project | false | none | none | |
preset | false | none | none | |
engineConfiguration | false | none | none | |
postScanActionData | string | false | read-only | none |
postScanActionName | string | false | read-only | none |
emailNotifications | Cx.Sast.ScanSettings.Presentation.Dtos.EmailNotificationsDto | false | none | none |
Cx.Sast.ScanSettings.Presentation.Dtos.EmailNotificationsDto
{
"failedScan": [
"string"
],
"beforeScan": [
"string"
],
"afterScan": [
"string"
]
}
Properties
Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
failedScan | [string] | false | none | none |
beforeScan | [string] | false | none | none |
afterScan | [string] | false | none | none |
Cx.Sast.ScanSettings.Presentation.Dtos.ScanSettingsRequestDto
{
"projectId": 1,
"presetId": 1,
"engineConfigurationId": 1,
"postScanActionId": 1,
"emailNotifications": {
"failedScan": [
"string"
],
"beforeScan": [
"string"
],
"afterScan": [
"string"
]
}
}
Properties
Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
projectId | integer(int64) | true | none | none |
presetId | integer(int64) | true | none | none |
engineConfigurationId | integer(int64) | true | none | none |
postScanActionId | integer(int64) | false | none | none |
emailNotifications | Cx.Sast.ScanSettings.Presentation.Dtos.EmailNotificationsDto | false | none | none |