List Findings
Request
GET
https://appsec.sourcecraft.tech/v1/findings
Query parameters
|
Name |
Description |
|
gitRepo |
Type: string Repository identifier. Accepts either internal repository ID (e.g., 88769874964302633) or public UUID (e.g., 0199140f-4343-7c06-a7e3-b835c305b629). These values can be obtained from the getRepo API (fields: id and uuid). Pattern: Example: |
|
pageSize |
Type: integer Pagination page size, maximum 250, default: 50 findings Default: Min value: Max value: |
|
pageToken |
Type: string Default: `` Example: `` |
|
defectGroupId |
Type: integer Internal numeric ID of the defect group (Long, not UUID). Deprecated: use defectGroupUuid instead. Default: |
|
defectGroupUuid |
Type: string | null UUID of the defect group. Takes priority over defectGroupId when both are provided. Example: |
Responses
200 OK
OK
Body
application/json
{
"data": [
{
"uuid": "123e4567-e89b-12d3-a456-426614174000",
"id": 0,
"codeBlock": "example",
"codeBlockHash": "example",
"fileName": "example",
"startLine": 0,
"endLine": 0,
"startColumn": 0,
"endColumn": 0,
"timeFound": 0,
"message": "example",
"properties": {},
"rule": {
"uuid": null,
"id": 0,
"repository": {
"uuid": null,
"id": 0,
"gitRepo": "example",
"organization": "example",
"organizationId": "example",
"organizationSlug": "example",
"name": "example",
"lastScanStatus": "REPO_STATUS_UNSPECIFIED",
"lastScanTime": 0
},
"ruleName": "example",
"ruleId": "example",
"engine": "example",
"type": "UNSPECIFIED",
"shortDescription": "example",
"fullDescription": "example",
"propertyBag": {},
"helpUri": "example",
"helpText": "example",
"severity": "NONE",
"cvssScore": 0.5,
"cwes": "example"
},
"commit": {
"uuid": null,
"id": 0,
"hash": "example",
"repository": null,
"scans": [
{}
]
},
"defectGroup": {
"uuid": null,
"id": 0,
"rule": null,
"codeBlock": "example",
"codeBlockHash": "example",
"commit": null,
"activities": [
{}
],
"latestCommitFoundHash": "example",
"latestStartLine": 0,
"latestEndLine": 0,
"latestStartColumn": 0,
"latestEndColumn": 0,
"latestFileName": "example",
"latestTimeFound": 0,
"firstCommitFoundHash": "example",
"firstTimeFound": 0,
"status": "OPEN",
"previousStatus": null,
"neuroTriageUuid": null,
"fixOperationUuid": null,
"neuroScore": null,
"repository": null,
"publicId": 0
},
"gitReference": {
"uuid": null,
"id": 0,
"type": "DEFAULT_BRANCH",
"name": "example",
"pullRequestId": "example",
"findings": [
null
],
"prComments": [
null
]
},
"scan": null,
"codeFlowSteps": [
{
"uuid": null,
"id": 0,
"finding": null,
"fileName": "example",
"startLine": 0,
"endLine": 0,
"startColumn": 0,
"endColumn": 0,
"codeBlock": "example",
"message": "example",
"stepOrder": 0,
"codeFlowIndex": 0,
"threadFlowIndex": 0
}
],
"relatedLocations": [
{
"uuid": null,
"id": 0,
"finding": null,
"relatedLocationId": 0,
"fileName": "example",
"startLine": 0,
"endLine": 0,
"startColumn": 0,
"endColumn": 0,
"message": "example"
}
],
"dastContext": {
"uuid": null,
"id": 0,
"finding": null,
"webRequest": "example",
"webResponse": "example"
},
"codeFlowHash": "example",
"filtered": true,
"codeBlockMissing": true
}
],
"nextPageToken": "example",
"totalSize": 0,
"listRevision": "example"
}
|
Name |
Description |
|
data |
Type: Finding[] Example |
|
nextPageToken |
Type: string Example: |
|
totalSize |
Type: integer |
|
listRevision |
Type: string | null Example: |
UUID
Type: string<uuid>
Pattern: [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}
Example: 123e4567-e89b-12d3-a456-426614174000
RepoStatus
Type: string
Enum: REPO_STATUS_UNSPECIFIED, REPO_STATUS_NO_RUNS_YET, REPO_STATUS_RUNNING, REPO_STATUS_FINISHED, REPO_STATUS_FAILED, UNRECOGNIZED
Repository
|
Name |
Description |
|
gitRepo |
Type: string Example: |
|
id |
Type: integer | null |
|
lastScanStatus |
Type: RepoStatus Enum: |
|
lastScanTime |
Type: integer |
|
name |
Type: string Example: |
|
organization |
Type: string Example: |
|
organizationId |
Type: string Example: |
|
organizationSlug |
Type: string Example: |
|
uuid |
Any of 2 types
Example: |
Example
{
"uuid": "123e4567-e89b-12d3-a456-426614174000",
"id": 0,
"gitRepo": "example",
"organization": "example",
"organizationId": "example",
"organizationSlug": "example",
"name": "example",
"lastScanStatus": "REPO_STATUS_UNSPECIFIED",
"lastScanTime": 0
}
EngineType1
Type: string
Enum: UNSPECIFIED, SECRETS, SCA, SAST, SBOM_SPDX, SBOM_CYCLONEDX, DAST, AI_AUDIT, UNRECOGNIZED
Severity
Type: string
Enum: NONE, LOW, MEDIUM, HIGH, CRITICAL, UNRECOGNIZED
Rule
|
Name |
Description |
|
cvssScore |
Type: number |
|
cwes |
Type: string | null Example: |
|
engine |
Type: string Example: |
|
fullDescription |
Type: string | null Example: |
|
helpText |
Type: string | null Example: |
|
helpUri |
Type: string | null Example: |
|
id |
Type: integer | null |
|
propertyBag |
Type: object | null Example |
|
repository |
Type: Repository Example |
|
ruleId |
Type: string Example: |
|
ruleName |
Type: string Example: |
|
severity |
Type: Severity Enum: |
|
shortDescription |
Type: string | null Example: |
|
type |
Type: EngineType1 Enum: |
|
uuid |
Any of 2 types
Example: |
Example
{
"uuid": "123e4567-e89b-12d3-a456-426614174000",
"id": 0,
"repository": {
"uuid": null,
"id": 0,
"gitRepo": "example",
"organization": "example",
"organizationId": "example",
"organizationSlug": "example",
"name": "example",
"lastScanStatus": "REPO_STATUS_UNSPECIFIED",
"lastScanTime": 0
},
"ruleName": "example",
"ruleId": "example",
"engine": "example",
"type": "UNSPECIFIED",
"shortDescription": "example",
"fullDescription": "example",
"propertyBag": {},
"helpUri": "example",
"helpText": "example",
"severity": "NONE",
"cvssScore": 0.5,
"cwes": "example"
}
ScanStatus
Type: string
Enum: INITIATED, FINISHED, FAILED
ScanType
Type: string
Enum: SCAN_TYPE_DEFAULT, SCAN_TYPE_AUDIT, SCAN_TYPE_CLOUD_DAST, UNRECOGNIZED
ScanOrigin
Type: string
Enum: UNKNOWN, CUSTOM, BUILT_IN, UNRECOGNIZED
Commit
|
Name |
Description |
|
hash |
Type: string Example: |
|
id |
Type: integer | null |
|
repository |
Type: Repository Example |
|
scans |
Type: Scan[] Unique items: Example |
|
uuid |
Any of 2 types
Example: |
Example
{
"uuid": "123e4567-e89b-12d3-a456-426614174000",
"id": 0,
"hash": "example",
"repository": {
"uuid": null,
"id": 0,
"gitRepo": "example",
"organization": "example",
"organizationId": "example",
"organizationSlug": "example",
"name": "example",
"lastScanStatus": "REPO_STATUS_UNSPECIFIED",
"lastScanTime": 0
},
"scans": [
{
"uuid": null,
"id": 0,
"status": "INITIATED",
"type": "SCAN_TYPE_DEFAULT",
"origin": "UNKNOWN",
"timeStarted": 0,
"timeFinished": 0,
"expectedReportCount": 0,
"receivedReportCount": 0,
"externalUuid": null,
"fluxId": "example",
"fluxPublicId": "example",
"newDelta": 0,
"closedDelta": 0,
"totalDefectGroups": 0,
"foundDefectGroups": 0,
"openDefectGroups": 0,
"repository": null,
"commit": {
"uuid": null,
"id": 0,
"hash": "example",
"repository": null,
"scans": [
null
]
},
"gitReference": {
"uuid": null,
"id": 0,
"type": "DEFAULT_BRANCH",
"name": "example",
"pullRequestId": "example",
"findings": [
null
],
"prComments": [
null
]
},
"findings": [
{
"uuid": null,
"id": 0,
"codeBlock": "example",
"codeBlockHash": "example",
"fileName": "example",
"startLine": 0,
"endLine": 0,
"startColumn": 0,
"endColumn": 0,
"timeFound": 0,
"message": "example",
"properties": {},
"rule": {},
"commit": null,
"defectGroup": {},
"gitReference": null,
"scan": null,
"codeFlowSteps": [
null
],
"relatedLocations": [
null
],
"dastContext": null,
"codeFlowHash": "example",
"filtered": true,
"codeBlockMissing": true
}
],
"artifacts": [
{
"uuid": null,
"id": 0,
"link": "example",
"engineName": "example",
"engineType": "UNSPECIFIED",
"scan": null
}
],
"dependencies": [
{
"uuid": null,
"id": 0,
"purl": "example",
"name": "example",
"version": "example",
"packageManager": "example",
"scans": [
null
]
}
]
}
]
}
ReferenceType
Type: string
Enum: DEFAULT_BRANCH, PULL_REQUEST, TAG, COMMIT, CUSTOM
Finding
|
Name |
Description |
|
codeBlock |
Type: string | null Example: |
|
codeBlockHash |
Type: string | null Example: |
|
codeBlockMissing |
Type: boolean |
|
codeFlowHash |
Type: string | null Example: |
|
codeFlowSteps |
Type: CodeFlowStep[] Example |
|
commit |
Type: Commit Example |
|
dastContext |
Any of 2 types
Example |
|
defectGroup |
Type: DefectGroup Example |
|
endColumn |
Type: integer |
|
endLine |
Type: integer |
|
fileName |
Type: string Example: |
|
filtered |
Type: boolean |
|
gitReference |
Any of 2 types
Example |
|
id |
Type: integer | null |
|
message |
Type: string | null Example: |
|
properties |
Type: object | null Example |
|
relatedLocations |
Type: RelatedLocation[] Example |
|
rule |
Type: Rule Example |
|
scan |
Any of 2 types
Example |
|
startColumn |
Type: integer |
|
startLine |
Type: integer |
|
timeFound |
Type: integer | null |
|
uuid |
Any of 2 types
Example: |
Example
{
"uuid": "123e4567-e89b-12d3-a456-426614174000",
"id": 0,
"codeBlock": "example",
"codeBlockHash": "example",
"fileName": "example",
"startLine": 0,
"endLine": 0,
"startColumn": 0,
"endColumn": 0,
"timeFound": 0,
"message": "example",
"properties": {},
"rule": {
"uuid": null,
"id": 0,
"repository": {
"uuid": null,
"id": 0,
"gitRepo": "example",
"organization": "example",
"organizationId": "example",
"organizationSlug": "example",
"name": "example",
"lastScanStatus": "REPO_STATUS_UNSPECIFIED",
"lastScanTime": 0
},
"ruleName": "example",
"ruleId": "example",
"engine": "example",
"type": "UNSPECIFIED",
"shortDescription": "example",
"fullDescription": "example",
"propertyBag": {},
"helpUri": "example",
"helpText": "example",
"severity": "NONE",
"cvssScore": 0.5,
"cwes": "example"
},
"commit": {
"uuid": null,
"id": 0,
"hash": "example",
"repository": null,
"scans": [
{
"uuid": null,
"id": 0,
"status": "INITIATED",
"type": "SCAN_TYPE_DEFAULT",
"origin": "UNKNOWN",
"timeStarted": 0,
"timeFinished": 0,
"expectedReportCount": 0,
"receivedReportCount": 0,
"externalUuid": null,
"fluxId": "example",
"fluxPublicId": "example",
"newDelta": 0,
"closedDelta": 0,
"totalDefectGroups": 0,
"foundDefectGroups": 0,
"openDefectGroups": 0,
"repository": null,
"commit": null,
"gitReference": {},
"findings": [
{}
],
"artifacts": [
{}
],
"dependencies": [
{}
]
}
]
},
"defectGroup": {
"uuid": null,
"id": 0,
"rule": null,
"codeBlock": "example",
"codeBlockHash": "example",
"commit": null,
"activities": [
{
"uuid": null,
"id": 0,
"activityComment": {},
"type": "ACTIVITY_TYPE_UNSPECIFIED",
"title": "example",
"createdAt": 0,
"dueDate": 0,
"createdByUserId": "example",
"createdByUserPublicId": "example",
"assignedToUserId": "example",
"newStatus": "OPEN",
"entityTags": [
{}
],
"attachments": [
{}
],
"isDeleted": true,
"deleted": true,
"previousStatus": null
}
],
"latestCommitFoundHash": "example",
"latestStartLine": 0,
"latestEndLine": 0,
"latestStartColumn": 0,
"latestEndColumn": 0,
"latestFileName": "example",
"latestTimeFound": 0,
"firstCommitFoundHash": "example",
"firstTimeFound": 0,
"status": null,
"previousStatus": null,
"neuroTriageUuid": null,
"fixOperationUuid": null,
"neuroScore": null,
"repository": null,
"publicId": 0
},
"gitReference": null,
"scan": null,
"codeFlowSteps": [
{
"uuid": null,
"id": 0,
"finding": null,
"fileName": "example",
"startLine": 0,
"endLine": 0,
"startColumn": 0,
"endColumn": 0,
"codeBlock": "example",
"message": "example",
"stepOrder": 0,
"codeFlowIndex": 0,
"threadFlowIndex": 0
}
],
"relatedLocations": [
{
"uuid": null,
"id": 0,
"finding": null,
"relatedLocationId": 0,
"fileName": "example",
"startLine": 0,
"endLine": 0,
"startColumn": 0,
"endColumn": 0,
"message": "example"
}
],
"dastContext": {
"uuid": null,
"id": 0,
"finding": null,
"webRequest": "example",
"webResponse": "example"
},
"codeFlowHash": "example",
"filtered": true,
"codeBlockMissing": true
}
GitReference
|
Name |
Description |
|
findings |
Type: Finding[] Example |
|
id |
Type: integer | null |
|
name |
Type: string Example: |
|
prComments |
Type: PrComment[] Example |
|
pullRequestId |
Type: string | null Example: |
|
type |
Type: ReferenceType Enum: |
|
uuid |
Any of 2 types
Example: |
Example
{
"uuid": "123e4567-e89b-12d3-a456-426614174000",
"id": 0,
"type": "DEFAULT_BRANCH",
"name": "example",
"pullRequestId": "example",
"findings": [
{
"uuid": null,
"id": 0,
"codeBlock": "example",
"codeBlockHash": "example",
"fileName": "example",
"startLine": 0,
"endLine": 0,
"startColumn": 0,
"endColumn": 0,
"timeFound": 0,
"message": "example",
"properties": {},
"rule": {
"uuid": null,
"id": 0,
"repository": {
"uuid": null,
"id": 0,
"gitRepo": "example",
"organization": "example",
"organizationId": "example",
"organizationSlug": "example",
"name": "example",
"lastScanStatus": "REPO_STATUS_UNSPECIFIED",
"lastScanTime": 0
},
"ruleName": "example",
"ruleId": "example",
"engine": "example",
"type": "UNSPECIFIED",
"shortDescription": "example",
"fullDescription": "example",
"propertyBag": {},
"helpUri": "example",
"helpText": "example",
"severity": "NONE",
"cvssScore": 0.5,
"cwes": "example"
},
"commit": {
"uuid": null,
"id": 0,
"hash": "example",
"repository": null,
"scans": [
{}
]
},
"defectGroup": {
"uuid": null,
"id": 0,
"rule": null,
"codeBlock": "example",
"codeBlockHash": "example",
"commit": null,
"activities": [
{}
],
"latestCommitFoundHash": "example",
"latestStartLine": 0,
"latestEndLine": 0,
"latestStartColumn": 0,
"latestEndColumn": 0,
"latestFileName": "example",
"latestTimeFound": 0,
"firstCommitFoundHash": "example",
"firstTimeFound": 0,
"status": "OPEN",
"previousStatus": null,
"neuroTriageUuid": null,
"fixOperationUuid": null,
"neuroScore": null,
"repository": null,
"publicId": 0
},
"gitReference": {
"uuid": null,
"id": 0,
"type": null,
"name": "example",
"pullRequestId": "example",
"findings": [
null
],
"prComments": [
null
]
},
"scan": null,
"codeFlowSteps": [
{
"uuid": null,
"id": 0,
"finding": null,
"fileName": "example",
"startLine": 0,
"endLine": 0,
"startColumn": 0,
"endColumn": 0,
"codeBlock": "example",
"message": "example",
"stepOrder": 0,
"codeFlowIndex": 0,
"threadFlowIndex": 0
}
],
"relatedLocations": [
{
"uuid": null,
"id": 0,
"finding": null,
"relatedLocationId": 0,
"fileName": "example",
"startLine": 0,
"endLine": 0,
"startColumn": 0,
"endColumn": 0,
"message": "example"
}
],
"dastContext": {
"uuid": null,
"id": 0,
"finding": null,
"webRequest": "example",
"webResponse": "example"
},
"codeFlowHash": "example",
"filtered": true,
"codeBlockMissing": true
}
],
"prComments": [
{
"uuid": null,
"id": 0,
"gitReference": null,
"externalCommentId": "example",
"defectGroup": null,
"createdAt": 0,
"fileName": "example",
"startLine": 0,
"endLine": 0
}
]
}
ActivityComment
|
Name |
Description |
|
content |
Type: string Example: |
|
id |
Type: integer | null |
|
uuid |
Any of 2 types
Example: |
Example
{
"uuid": "123e4567-e89b-12d3-a456-426614174000",
"id": 0,
"content": "example"
}
ActivityType
Type: string
Enum: ACTIVITY_TYPE_UNSPECIFIED, CREATED, ASSIGNED, REASSIGNED, STATUS_CHANGED, COMMENT_ADDED, PRIORITY_ADDED, PRIORITY_CHANGED, DUE_DATE_ADDED, DUE_DATE_CHANGED, DUE_DATE_BREACHED, TAGS_ADDED, TAGS_CHANGED, RELATED_ISSUES_CHANGED, AI_SUGGESTION_ADDED, RELATED_ISSUES_REMOVED, AI_FIX_STARTED, AI_FIX_PR_LINKED, AI_STATUS_CHANGED, UNRECOGNIZED
DefectGroupStatus
Type: string
Enum: OPEN, RESOLVED_FIXED, RESOLVED_FP, RESOLVED_PROJECT_NOT_AFFECTED, RESOLVED_TOLERABLE, RESOLVED_DUPLICATE, TRIAGE_IN_PROGRESS, TRIAGED_TP, FIX_IN_PROGRESS, RESOLVED_AUTOFIXED, UNRECOGNIZED
TagDto
|
Name |
Description |
|
description |
Type: string Example: |
|
name |
Type: string Example: |
Example
{
"name": "example",
"description": "example"
}
AttachmentDto
|
Name |
Description |
|
id |
Type: string Example: |
Example
{
"id": "example"
}
Activity
|
Name |
Description |
|
activityComment |
Any of 2 types
Example |
|
assignedToUserId |
Type: string Example: |
|
attachments |
Type: AttachmentDto[] Example |
|
createdAt |
Type: integer |
|
createdByUserId |
Type: string Example: |
|
createdByUserPublicId |
Type: string Example: |
|
deleted |
Type: boolean |
|
dueDate |
Type: integer |
|
entityTags |
Type: TagDto[] Example |
|
id |
Type: integer | null |
|
isDeleted |
Type: boolean |
|
newStatus |
Type: DefectGroupStatus Enum: |
|
previousStatus |
Type: DefectGroupStatus Enum: |
|
title |
Type: string Example: |
|
type |
Type: ActivityType Enum: |
|
uuid |
Any of 2 types
Example: |
Example
{
"uuid": "123e4567-e89b-12d3-a456-426614174000",
"id": 0,
"activityComment": {
"uuid": null,
"id": 0,
"content": "example"
},
"type": "ACTIVITY_TYPE_UNSPECIFIED",
"title": "example",
"createdAt": 0,
"dueDate": 0,
"createdByUserId": "example",
"createdByUserPublicId": "example",
"assignedToUserId": "example",
"newStatus": "OPEN",
"entityTags": [
{
"name": "example",
"description": "example"
}
],
"attachments": [
{
"id": "example"
}
],
"isDeleted": true,
"deleted": true,
"previousStatus": null
}
Scan
|
Name |
Description |
|
artifacts |
Type: Artifact[] Example |
|
closedDelta |
Type: integer | null |
|
commit |
Type: Commit Example |
|
dependencies |
Type: Dependency[] Unique items: Example |
|
expectedReportCount |
Type: integer |
|
externalUuid |
Any of 2 types
Example: |
|
findings |
Type: Finding[] Example |
|
fluxId |
Type: string | null Example: |
|
fluxPublicId |
Type: string Example: |
|
foundDefectGroups |
Type: integer | null |
|
gitReference |
Any of 2 types
Example |
|
id |
Type: integer | null |
|
newDelta |
Type: integer | null |
|
openDefectGroups |
Type: integer | null |
|
origin |
Type: ScanOrigin Enum: |
|
receivedReportCount |
Type: integer |
|
repository |
Type: Repository Example |
|
status |
Type: ScanStatus Enum: |
|
timeFinished |
Type: integer | null |
|
timeStarted |
Type: integer | null |
|
totalDefectGroups |
Type: integer | null |
|
type |
Type: ScanType Enum: |
|
uuid |
Any of 2 types
Example: |
Example
{
"uuid": "123e4567-e89b-12d3-a456-426614174000",
"id": 0,
"status": "INITIATED",
"type": "SCAN_TYPE_DEFAULT",
"origin": "UNKNOWN",
"timeStarted": 0,
"timeFinished": 0,
"expectedReportCount": 0,
"receivedReportCount": 0,
"externalUuid": null,
"fluxId": "example",
"fluxPublicId": "example",
"newDelta": 0,
"closedDelta": 0,
"totalDefectGroups": 0,
"foundDefectGroups": 0,
"openDefectGroups": 0,
"repository": {
"uuid": null,
"id": 0,
"gitRepo": "example",
"organization": "example",
"organizationId": "example",
"organizationSlug": "example",
"name": "example",
"lastScanStatus": "REPO_STATUS_UNSPECIFIED",
"lastScanTime": 0
},
"commit": {
"uuid": null,
"id": 0,
"hash": "example",
"repository": null,
"scans": [
{
"uuid": null,
"id": 0,
"status": null,
"type": null,
"origin": null,
"timeStarted": 0,
"timeFinished": 0,
"expectedReportCount": 0,
"receivedReportCount": 0,
"externalUuid": null,
"fluxId": "example",
"fluxPublicId": "example",
"newDelta": 0,
"closedDelta": 0,
"totalDefectGroups": 0,
"foundDefectGroups": 0,
"openDefectGroups": 0,
"repository": null,
"commit": null,
"gitReference": {},
"findings": [
{}
],
"artifacts": [
{}
],
"dependencies": [
{}
]
}
]
},
"gitReference": null,
"findings": [
null
],
"artifacts": [
null
],
"dependencies": [
null
]
}
EngineType
Type: string
Enum: UNSPECIFIED, SECRETS, SCA, SAST, SBOM_SPDX_GEN, SBOM_CYCLONEDX_GEN, DAST, AI_AUDIT
Artifact
|
Name |
Description |
|
engineName |
Type: string Example: |
|
engineType |
Type: EngineType Enum: |
|
id |
Type: integer | null |
|
link |
Type: string Example: |
|
scan |
Type: Scan Example |
|
uuid |
Any of 2 types
Example: |
Example
{
"uuid": "123e4567-e89b-12d3-a456-426614174000",
"id": 0,
"link": "example",
"engineName": "example",
"engineType": "UNSPECIFIED",
"scan": {
"uuid": null,
"id": 0,
"status": "INITIATED",
"type": "SCAN_TYPE_DEFAULT",
"origin": "UNKNOWN",
"timeStarted": 0,
"timeFinished": 0,
"expectedReportCount": 0,
"receivedReportCount": 0,
"externalUuid": null,
"fluxId": "example",
"fluxPublicId": "example",
"newDelta": 0,
"closedDelta": 0,
"totalDefectGroups": 0,
"foundDefectGroups": 0,
"openDefectGroups": 0,
"repository": {
"uuid": null,
"id": 0,
"gitRepo": "example",
"organization": "example",
"organizationId": "example",
"organizationSlug": "example",
"name": "example",
"lastScanStatus": "REPO_STATUS_UNSPECIFIED",
"lastScanTime": 0
},
"commit": {
"uuid": null,
"id": 0,
"hash": "example",
"repository": null,
"scans": [
null
]
},
"gitReference": {
"uuid": null,
"id": 0,
"type": "DEFAULT_BRANCH",
"name": "example",
"pullRequestId": "example",
"findings": [
{}
],
"prComments": [
{}
]
},
"findings": [
null
],
"artifacts": [
{
"uuid": null,
"id": 0,
"link": "example",
"engineName": "example",
"engineType": null,
"scan": null
}
],
"dependencies": [
{
"uuid": null,
"id": 0,
"purl": "example",
"name": "example",
"version": "example",
"packageManager": "example",
"scans": [
null
]
}
]
}
}
Dependency
|
Name |
Description |
|
id |
Type: integer | null |
|
name |
Type: string Example: |
|
packageManager |
Type: string | null Example: |
|
purl |
Type: string Example: |
|
scans |
Type: Scan[] Unique items: Example |
|
uuid |
Any of 2 types
Example: |
|
version |
Type: string | null Example: |
Example
{
"uuid": "123e4567-e89b-12d3-a456-426614174000",
"id": 0,
"purl": "example",
"name": "example",
"version": "example",
"packageManager": "example",
"scans": [
{
"uuid": null,
"id": 0,
"status": "INITIATED",
"type": "SCAN_TYPE_DEFAULT",
"origin": "UNKNOWN",
"timeStarted": 0,
"timeFinished": 0,
"expectedReportCount": 0,
"receivedReportCount": 0,
"externalUuid": null,
"fluxId": "example",
"fluxPublicId": "example",
"newDelta": 0,
"closedDelta": 0,
"totalDefectGroups": 0,
"foundDefectGroups": 0,
"openDefectGroups": 0,
"repository": {
"uuid": null,
"id": 0,
"gitRepo": "example",
"organization": "example",
"organizationId": "example",
"organizationSlug": "example",
"name": "example",
"lastScanStatus": "REPO_STATUS_UNSPECIFIED",
"lastScanTime": 0
},
"commit": {
"uuid": null,
"id": 0,
"hash": "example",
"repository": null,
"scans": [
null
]
},
"gitReference": {
"uuid": null,
"id": 0,
"type": "DEFAULT_BRANCH",
"name": "example",
"pullRequestId": "example",
"findings": [
null
],
"prComments": [
null
]
},
"findings": [
{
"uuid": null,
"id": 0,
"codeBlock": "example",
"codeBlockHash": "example",
"fileName": "example",
"startLine": 0,
"endLine": 0,
"startColumn": 0,
"endColumn": 0,
"timeFound": 0,
"message": "example",
"properties": {},
"rule": {},
"commit": null,
"defectGroup": {},
"gitReference": null,
"scan": null,
"codeFlowSteps": [
null
],
"relatedLocations": [
null
],
"dastContext": null,
"codeFlowHash": "example",
"filtered": true,
"codeBlockMissing": true
}
],
"artifacts": [
{
"uuid": null,
"id": 0,
"link": "example",
"engineName": "example",
"engineType": "UNSPECIFIED",
"scan": null
}
],
"dependencies": [
{
"uuid": null,
"id": 0,
"purl": "example",
"name": "example",
"version": "example",
"packageManager": "example",
"scans": [
null
]
}
]
}
]
}
PrComment
|
Name |
Description |
|
createdAt |
Type: integer |
|
defectGroup |
Type: DefectGroup Example |
|
endLine |
Type: integer | null |
|
externalCommentId |
Type: string Example: |
|
fileName |
Type: string | null Example: |
|
gitReference |
Type: GitReference Example |
|
id |
Type: integer | null |
|
startLine |
Type: integer | null |
|
uuid |
Any of 2 types
Example: |
Example
{
"uuid": "123e4567-e89b-12d3-a456-426614174000",
"id": 0,
"gitReference": {
"uuid": null,
"id": 0,
"type": "DEFAULT_BRANCH",
"name": "example",
"pullRequestId": "example",
"findings": [
{
"uuid": null,
"id": 0,
"codeBlock": "example",
"codeBlockHash": "example",
"fileName": "example",
"startLine": 0,
"endLine": 0,
"startColumn": 0,
"endColumn": 0,
"timeFound": 0,
"message": "example",
"properties": {},
"rule": {
"uuid": null,
"id": 0,
"repository": {},
"ruleName": "example",
"ruleId": "example",
"engine": "example",
"type": "UNSPECIFIED",
"shortDescription": "example",
"fullDescription": "example",
"propertyBag": {},
"helpUri": "example",
"helpText": "example",
"severity": "NONE",
"cvssScore": 0.5,
"cwes": "example"
},
"commit": {
"uuid": null,
"id": 0,
"hash": "example",
"repository": null,
"scans": [
null
]
},
"defectGroup": {
"uuid": null,
"id": 0,
"rule": null,
"codeBlock": "example",
"codeBlockHash": "example",
"commit": null,
"activities": [
null
],
"latestCommitFoundHash": "example",
"latestStartLine": 0,
"latestEndLine": 0,
"latestStartColumn": 0,
"latestEndColumn": 0,
"latestFileName": "example",
"latestTimeFound": 0,
"firstCommitFoundHash": "example",
"firstTimeFound": 0,
"status": "OPEN",
"previousStatus": null,
"neuroTriageUuid": null,
"fixOperationUuid": null,
"neuroScore": null,
"repository": null,
"publicId": 0
},
"gitReference": null,
"scan": {},
"codeFlowSteps": [
{}
],
"relatedLocations": [
{}
],
"dastContext": {},
"codeFlowHash": "example",
"filtered": true,
"codeBlockMissing": true
}
],
"prComments": [
{
"uuid": null,
"id": 0,
"gitReference": null,
"externalCommentId": "example",
"defectGroup": null,
"createdAt": 0,
"fileName": "example",
"startLine": 0,
"endLine": 0
}
]
},
"externalCommentId": "example",
"defectGroup": null,
"createdAt": 0,
"fileName": "example",
"startLine": 0,
"endLine": 0
}
DefectGroup
|
Name |
Description |
|
activities |
Type: Activity[] Example |
|
codeBlock |
Type: string Example: |
|
codeBlockHash |
Type: string Example: |
|
commit |
Type: Commit Example |
|
firstCommitFoundHash |
Type: string Example: |
|
firstTimeFound |
Type: integer |
|
fixOperationUuid |
Any of 2 types
Example: |
|
id |
Type: integer | null |
|
latestCommitFoundHash |
Type: string Example: |
|
latestEndColumn |
Type: integer |
|
latestEndLine |
Type: integer |
|
latestFileName |
Type: string Example: |
|
latestStartColumn |
Type: integer |
|
latestStartLine |
Type: integer |
|
latestTimeFound |
Type: integer | null |
|
neuroScore |
Type: Severity Enum: |
|
neuroTriageUuid |
Any of 2 types
Example: |
|
previousStatus |
Any of 2 types
Example: |
|
publicId |
Type: integer |
|
repository |
Type: Repository Example |
|
rule |
Type: Rule Example |
|
status |
Type: DefectGroupStatus Enum: |
|
uuid |
Any of 2 types
Example: |
Example
{
"uuid": "123e4567-e89b-12d3-a456-426614174000",
"id": 0,
"rule": {
"uuid": null,
"id": 0,
"repository": {
"uuid": null,
"id": 0,
"gitRepo": "example",
"organization": "example",
"organizationId": "example",
"organizationSlug": "example",
"name": "example",
"lastScanStatus": "REPO_STATUS_UNSPECIFIED",
"lastScanTime": 0
},
"ruleName": "example",
"ruleId": "example",
"engine": "example",
"type": "UNSPECIFIED",
"shortDescription": "example",
"fullDescription": "example",
"propertyBag": {},
"helpUri": "example",
"helpText": "example",
"severity": "NONE",
"cvssScore": 0.5,
"cwes": "example"
},
"codeBlock": "example",
"codeBlockHash": "example",
"commit": {
"uuid": null,
"id": 0,
"hash": "example",
"repository": null,
"scans": [
{
"uuid": null,
"id": 0,
"status": "INITIATED",
"type": "SCAN_TYPE_DEFAULT",
"origin": "UNKNOWN",
"timeStarted": 0,
"timeFinished": 0,
"expectedReportCount": 0,
"receivedReportCount": 0,
"externalUuid": null,
"fluxId": "example",
"fluxPublicId": "example",
"newDelta": 0,
"closedDelta": 0,
"totalDefectGroups": 0,
"foundDefectGroups": 0,
"openDefectGroups": 0,
"repository": null,
"commit": null,
"gitReference": {},
"findings": [
{}
],
"artifacts": [
{}
],
"dependencies": [
{}
]
}
]
},
"activities": [
{
"uuid": null,
"id": 0,
"activityComment": {
"uuid": null,
"id": 0,
"content": "example"
},
"type": "ACTIVITY_TYPE_UNSPECIFIED",
"title": "example",
"createdAt": 0,
"dueDate": 0,
"createdByUserId": "example",
"createdByUserPublicId": "example",
"assignedToUserId": "example",
"newStatus": "OPEN",
"entityTags": [
{
"name": "example",
"description": "example"
}
],
"attachments": [
{
"id": "example"
}
],
"isDeleted": true,
"deleted": true,
"previousStatus": null
}
],
"latestCommitFoundHash": "example",
"latestStartLine": 0,
"latestEndLine": 0,
"latestStartColumn": 0,
"latestEndColumn": 0,
"latestFileName": "example",
"latestTimeFound": 0,
"firstCommitFoundHash": "example",
"firstTimeFound": 0,
"status": null,
"previousStatus": null,
"neuroTriageUuid": null,
"fixOperationUuid": null,
"neuroScore": null,
"repository": null,
"publicId": 0
}
CodeFlowStep
|
Name |
Description |
|
codeBlock |
Type: string | null Example: |
|
codeFlowIndex |
Type: integer |
|
endColumn |
Type: integer |
|
endLine |
Type: integer |
|
fileName |
Type: string Example: |
|
finding |
Type: Finding Example |
|
id |
Type: integer | null |
|
message |
Type: string | null Example: |
|
startColumn |
Type: integer |
|
startLine |
Type: integer |
|
stepOrder |
Type: integer |
|
threadFlowIndex |
Type: integer |
|
uuid |
Any of 2 types
Example: |
Example
{
"uuid": "123e4567-e89b-12d3-a456-426614174000",
"id": 0,
"finding": {
"uuid": null,
"id": 0,
"codeBlock": "example",
"codeBlockHash": "example",
"fileName": "example",
"startLine": 0,
"endLine": 0,
"startColumn": 0,
"endColumn": 0,
"timeFound": 0,
"message": "example",
"properties": {},
"rule": {
"uuid": null,
"id": 0,
"repository": {
"uuid": null,
"id": 0,
"gitRepo": "example",
"organization": "example",
"organizationId": "example",
"organizationSlug": "example",
"name": "example",
"lastScanStatus": "REPO_STATUS_UNSPECIFIED",
"lastScanTime": 0
},
"ruleName": "example",
"ruleId": "example",
"engine": "example",
"type": "UNSPECIFIED",
"shortDescription": "example",
"fullDescription": "example",
"propertyBag": {},
"helpUri": "example",
"helpText": "example",
"severity": "NONE",
"cvssScore": 0.5,
"cwes": "example"
},
"commit": {
"uuid": null,
"id": 0,
"hash": "example",
"repository": null,
"scans": [
{
"uuid": null,
"id": 0,
"status": "INITIATED",
"type": "SCAN_TYPE_DEFAULT",
"origin": "UNKNOWN",
"timeStarted": 0,
"timeFinished": 0,
"expectedReportCount": 0,
"receivedReportCount": 0,
"externalUuid": null,
"fluxId": "example",
"fluxPublicId": "example",
"newDelta": 0,
"closedDelta": 0,
"totalDefectGroups": 0,
"foundDefectGroups": 0,
"openDefectGroups": 0,
"repository": null,
"commit": null,
"gitReference": null,
"findings": [
null
],
"artifacts": [
null
],
"dependencies": [
null
]
}
]
},
"defectGroup": {
"uuid": null,
"id": 0,
"rule": null,
"codeBlock": "example",
"codeBlockHash": "example",
"commit": null,
"activities": [
{
"uuid": null,
"id": 0,
"activityComment": null,
"type": "ACTIVITY_TYPE_UNSPECIFIED",
"title": "example",
"createdAt": 0,
"dueDate": 0,
"createdByUserId": "example",
"createdByUserPublicId": "example",
"assignedToUserId": "example",
"newStatus": "OPEN",
"entityTags": [
null
],
"attachments": [
null
],
"isDeleted": true,
"deleted": true,
"previousStatus": null
}
],
"latestCommitFoundHash": "example",
"latestStartLine": 0,
"latestEndLine": 0,
"latestStartColumn": 0,
"latestEndColumn": 0,
"latestFileName": "example",
"latestTimeFound": 0,
"firstCommitFoundHash": "example",
"firstTimeFound": 0,
"status": null,
"previousStatus": null,
"neuroTriageUuid": null,
"fixOperationUuid": null,
"neuroScore": null,
"repository": null,
"publicId": 0
},
"gitReference": {
"uuid": null,
"id": 0,
"type": "DEFAULT_BRANCH",
"name": "example",
"pullRequestId": "example",
"findings": [
null
],
"prComments": [
{}
]
},
"scan": null,
"codeFlowSteps": [
{
"uuid": null,
"id": 0,
"finding": null,
"fileName": "example",
"startLine": 0,
"endLine": 0,
"startColumn": 0,
"endColumn": 0,
"codeBlock": "example",
"message": "example",
"stepOrder": 0,
"codeFlowIndex": 0,
"threadFlowIndex": 0
}
],
"relatedLocations": [
{
"uuid": null,
"id": 0,
"finding": null,
"relatedLocationId": 0,
"fileName": "example",
"startLine": 0,
"endLine": 0,
"startColumn": 0,
"endColumn": 0,
"message": "example"
}
],
"dastContext": {
"uuid": null,
"id": 0,
"finding": null,
"webRequest": "example",
"webResponse": "example"
},
"codeFlowHash": "example",
"filtered": true,
"codeBlockMissing": true
},
"fileName": "example",
"startLine": 0,
"endLine": 0,
"startColumn": 0,
"endColumn": 0,
"codeBlock": "example",
"message": "example",
"stepOrder": 0,
"codeFlowIndex": 0,
"threadFlowIndex": 0
}
RelatedLocation
|
Name |
Description |
|
endColumn |
Type: integer |
|
endLine |
Type: integer |
|
fileName |
Type: string Example: |
|
finding |
Type: Finding Example |
|
id |
Type: integer | null |
|
message |
Type: string | null Example: |
|
relatedLocationId |
Type: integer | null |
|
startColumn |
Type: integer |
|
startLine |
Type: integer |
|
uuid |
Any of 2 types
Example: |
Example
{
"uuid": "123e4567-e89b-12d3-a456-426614174000",
"id": 0,
"finding": {
"uuid": null,
"id": 0,
"codeBlock": "example",
"codeBlockHash": "example",
"fileName": "example",
"startLine": 0,
"endLine": 0,
"startColumn": 0,
"endColumn": 0,
"timeFound": 0,
"message": "example",
"properties": {},
"rule": {
"uuid": null,
"id": 0,
"repository": {
"uuid": null,
"id": 0,
"gitRepo": "example",
"organization": "example",
"organizationId": "example",
"organizationSlug": "example",
"name": "example",
"lastScanStatus": "REPO_STATUS_UNSPECIFIED",
"lastScanTime": 0
},
"ruleName": "example",
"ruleId": "example",
"engine": "example",
"type": "UNSPECIFIED",
"shortDescription": "example",
"fullDescription": "example",
"propertyBag": {},
"helpUri": "example",
"helpText": "example",
"severity": "NONE",
"cvssScore": 0.5,
"cwes": "example"
},
"commit": {
"uuid": null,
"id": 0,
"hash": "example",
"repository": null,
"scans": [
{
"uuid": null,
"id": 0,
"status": "INITIATED",
"type": "SCAN_TYPE_DEFAULT",
"origin": "UNKNOWN",
"timeStarted": 0,
"timeFinished": 0,
"expectedReportCount": 0,
"receivedReportCount": 0,
"externalUuid": null,
"fluxId": "example",
"fluxPublicId": "example",
"newDelta": 0,
"closedDelta": 0,
"totalDefectGroups": 0,
"foundDefectGroups": 0,
"openDefectGroups": 0,
"repository": null,
"commit": null,
"gitReference": null,
"findings": [
null
],
"artifacts": [
null
],
"dependencies": [
null
]
}
]
},
"defectGroup": {
"uuid": null,
"id": 0,
"rule": null,
"codeBlock": "example",
"codeBlockHash": "example",
"commit": null,
"activities": [
{
"uuid": null,
"id": 0,
"activityComment": null,
"type": "ACTIVITY_TYPE_UNSPECIFIED",
"title": "example",
"createdAt": 0,
"dueDate": 0,
"createdByUserId": "example",
"createdByUserPublicId": "example",
"assignedToUserId": "example",
"newStatus": "OPEN",
"entityTags": [
null
],
"attachments": [
null
],
"isDeleted": true,
"deleted": true,
"previousStatus": null
}
],
"latestCommitFoundHash": "example",
"latestStartLine": 0,
"latestEndLine": 0,
"latestStartColumn": 0,
"latestEndColumn": 0,
"latestFileName": "example",
"latestTimeFound": 0,
"firstCommitFoundHash": "example",
"firstTimeFound": 0,
"status": null,
"previousStatus": null,
"neuroTriageUuid": null,
"fixOperationUuid": null,
"neuroScore": null,
"repository": null,
"publicId": 0
},
"gitReference": {
"uuid": null,
"id": 0,
"type": "DEFAULT_BRANCH",
"name": "example",
"pullRequestId": "example",
"findings": [
null
],
"prComments": [
{}
]
},
"scan": null,
"codeFlowSteps": [
{
"uuid": null,
"id": 0,
"finding": null,
"fileName": "example",
"startLine": 0,
"endLine": 0,
"startColumn": 0,
"endColumn": 0,
"codeBlock": "example",
"message": "example",
"stepOrder": 0,
"codeFlowIndex": 0,
"threadFlowIndex": 0
}
],
"relatedLocations": [
{
"uuid": null,
"id": 0,
"finding": null,
"relatedLocationId": 0,
"fileName": "example",
"startLine": 0,
"endLine": 0,
"startColumn": 0,
"endColumn": 0,
"message": "example"
}
],
"dastContext": {
"uuid": null,
"id": 0,
"finding": null,
"webRequest": "example",
"webResponse": "example"
},
"codeFlowHash": "example",
"filtered": true,
"codeBlockMissing": true
},
"relatedLocationId": 0,
"fileName": "example",
"startLine": 0,
"endLine": 0,
"startColumn": 0,
"endColumn": 0,
"message": "example"
}
DastContext
|
Name |
Description |
|
finding |
Type: Finding Example |
|
id |
Type: integer | null |
|
uuid |
Any of 2 types
Example: |
|
webRequest |
Type: string | null Example: |
|
webResponse |
Type: string | null Example: |
Example
{
"uuid": "123e4567-e89b-12d3-a456-426614174000",
"id": 0,
"finding": {
"uuid": null,
"id": 0,
"codeBlock": "example",
"codeBlockHash": "example",
"fileName": "example",
"startLine": 0,
"endLine": 0,
"startColumn": 0,
"endColumn": 0,
"timeFound": 0,
"message": "example",
"properties": {},
"rule": {
"uuid": null,
"id": 0,
"repository": {
"uuid": null,
"id": 0,
"gitRepo": "example",
"organization": "example",
"organizationId": "example",
"organizationSlug": "example",
"name": "example",
"lastScanStatus": "REPO_STATUS_UNSPECIFIED",
"lastScanTime": 0
},
"ruleName": "example",
"ruleId": "example",
"engine": "example",
"type": "UNSPECIFIED",
"shortDescription": "example",
"fullDescription": "example",
"propertyBag": {},
"helpUri": "example",
"helpText": "example",
"severity": "NONE",
"cvssScore": 0.5,
"cwes": "example"
},
"commit": {
"uuid": null,
"id": 0,
"hash": "example",
"repository": null,
"scans": [
{
"uuid": null,
"id": 0,
"status": "INITIATED",
"type": "SCAN_TYPE_DEFAULT",
"origin": "UNKNOWN",
"timeStarted": 0,
"timeFinished": 0,
"expectedReportCount": 0,
"receivedReportCount": 0,
"externalUuid": null,
"fluxId": "example",
"fluxPublicId": "example",
"newDelta": 0,
"closedDelta": 0,
"totalDefectGroups": 0,
"foundDefectGroups": 0,
"openDefectGroups": 0,
"repository": null,
"commit": null,
"gitReference": null,
"findings": [
null
],
"artifacts": [
null
],
"dependencies": [
null
]
}
]
},
"defectGroup": {
"uuid": null,
"id": 0,
"rule": null,
"codeBlock": "example",
"codeBlockHash": "example",
"commit": null,
"activities": [
{
"uuid": null,
"id": 0,
"activityComment": null,
"type": "ACTIVITY_TYPE_UNSPECIFIED",
"title": "example",
"createdAt": 0,
"dueDate": 0,
"createdByUserId": "example",
"createdByUserPublicId": "example",
"assignedToUserId": "example",
"newStatus": "OPEN",
"entityTags": [
null
],
"attachments": [
null
],
"isDeleted": true,
"deleted": true,
"previousStatus": null
}
],
"latestCommitFoundHash": "example",
"latestStartLine": 0,
"latestEndLine": 0,
"latestStartColumn": 0,
"latestEndColumn": 0,
"latestFileName": "example",
"latestTimeFound": 0,
"firstCommitFoundHash": "example",
"firstTimeFound": 0,
"status": null,
"previousStatus": null,
"neuroTriageUuid": null,
"fixOperationUuid": null,
"neuroScore": null,
"repository": null,
"publicId": 0
},
"gitReference": {
"uuid": null,
"id": 0,
"type": "DEFAULT_BRANCH",
"name": "example",
"pullRequestId": "example",
"findings": [
null
],
"prComments": [
{}
]
},
"scan": null,
"codeFlowSteps": [
{
"uuid": null,
"id": 0,
"finding": null,
"fileName": "example",
"startLine": 0,
"endLine": 0,
"startColumn": 0,
"endColumn": 0,
"codeBlock": "example",
"message": "example",
"stepOrder": 0,
"codeFlowIndex": 0,
"threadFlowIndex": 0
}
],
"relatedLocations": [
{
"uuid": null,
"id": 0,
"finding": null,
"relatedLocationId": 0,
"fileName": "example",
"startLine": 0,
"endLine": 0,
"startColumn": 0,
"endColumn": 0,
"message": "example"
}
],
"dastContext": {
"uuid": null,
"id": 0,
"finding": null,
"webRequest": "example",
"webResponse": "example"
},
"codeFlowHash": "example",
"filtered": true,
"codeBlockMissing": true
},
"webRequest": "example",
"webResponse": "example"
}
No longer supported, please use an alternative and newer version.