Search issues

1 curl -X POST https://zeropath.com//api/v1/issues/search \ 2 -H "X-ZeroPath-API-Token-Id: <apiTokenId>" \ 3 -H "Content-Type: application/json" \ 4 -d '{}'

1 { 2 "issues": [ 3 { 4 "id": "id", 5 "repositoryId": "repositoryId", 6 "status": "open", 7 "generatedTitle": "generatedTitle", 8 "generatedDescription": "generatedDescription", 9 "language": "language", 10 "vulnClass": "vulnClass", 11 "cwes": [ 12 "cwes" 13 ], 14 "vulnCategory": "SAST", 15 "severity": 1, 16 "affectedFile": "affectedFile", 17 "sastCodeSegment": "sastCodeSegment", 18 "startLine": 1, 19 "endLine": 1, 20 "isPrBlocked": true, 21 "triagePhase": "VulnerabilityValidation", 22 "createdAt": "2024-01-15T09:30:00Z", 23 "updatedAt": "2024-01-15T09:30:00Z", 24 "repositoryName": "repositoryName", 25 "businessLogicScenario": "businessLogicScenario", 26 "confidence": 1, 27 "score": 1, 28 "startColumn": 1, 29 "endColumn": 1, 30 "validated": "CONFIRMED", 31 "validationSecurityAssessment": "validationSecurityAssessment", 32 "unpatchable": true, 33 "archivedAt": "2024-01-15T09:30:00Z", 34 "noLongerDetectedAt": "2024-01-15T09:30:00Z", 35 "noLongerDetectedReason": "noLongerDetectedReason", 36 "naturalLanguageRuleEvaluationId": "naturalLanguageRuleEvaluationId" 37 } 38 ], 39 "totalCount": 1, 40 "categoryCounts": { 41 "open": 1, 42 "patched": 1, 43 "falsePositive": 1, 44 "archived": 1, 45 "processing": 1 46 }, 47 "currentPage": 1, 48 "pageSize": 1 49 }

Search for security issues across your repositories. You can filter by various criteria including custom rule ID.

To find all issues detected by a specific custom rule, include the ruleId parameter in your request.

Request

This endpoint expects an object.

organizationIdstringOptional

pageintegerOptional>=1Defaults to 1

pageSizeintegerOptional>=1Defaults to 10

searchQuerystringOptional

severitiesobjectOptional

sortByenumOptionalDefaults to score

Allowed values:

sortOrderenumOptionalDefaults to desc

Allowed values:

languageslist of stringsOptional

vulnerabilityClasseslist of stringsOptional

repositoryIdslist of stringsOptional

projectIdstringOptional

scanIdstringOptional

codeScanTypeslist of enumsOptional

Allowed values:

typeslist of enumsOptional

Allowed values:

getCountsbooleanOptional

returnAllbooleanOptional

ruleIdstringOptional

Filter issues by custom rule ID - returns only issues that were found by the specified custom rule

Response

Successful response

issueslist of objects or null

totalCountinteger or null

categoryCountsobject or null

currentPageinteger or null

pageSizeinteger or null

Headers

Request

Response

Errors