POST
/
api
/
v1
/
issues
/
search
Search issues
curl --request POST \
  --url https://zeropath.com/api/v1/issues/search \
  --header 'Content-Type: application/json' \
  --header 'X-ZeroPath-API-Token-Id: <api-key>' \
  --header 'X-ZeroPath-API-Token-Secret: <api-key>' \
  --data '{
  "organizationId": "<string>",
  "page": 1,
  "pageSize": 10,
  "searchQuery": "<string>",
  "severities": {
    "min": 5,
    "max": 5
  },
  "sortBy": "score",
  "sortOrder": "desc",
  "languages": [
    "<string>"
  ],
  "vulnerabilityClasses": [
    "<string>"
  ],
  "repositoryIds": [
    "<string>"
  ],
  "projectId": "<string>",
  "scanId": "<string>",
  "codeScanTypes": [
    "FullScan"
  ],
  "types": [
    "open"
  ],
  "getCounts": true,
  "returnAll": true,
  "ruleId": "<string>"
}'
{
  "issues": [
    {
      "id": "<string>",
      "repositoryId": "<string>",
      "repositoryName": "<string>",
      "status": "open",
      "generatedTitle": "<string>",
      "generatedDescription": "<string>",
      "businessLogicScenario": "<string>",
      "language": "<string>",
      "vulnClass": "<string>",
      "cwes": [
        "<string>"
      ],
      "vulnCategory": "SAST",
      "severity": 123,
      "confidence": 123,
      "score": 123,
      "affectedFile": "<string>",
      "sastCodeSegment": "<string>",
      "startLine": 123,
      "endLine": 123,
      "startColumn": 123,
      "endColumn": 123,
      "isPrBlocked": true,
      "triagePhase": "VulnerabilityValidation",
      "validated": "CONFIRMED",
      "validationSecurityAssessment": "<string>",
      "unpatchable": true,
      "unpatchableReason": "<string>",
      "archivedAt": "2023-11-07T05:31:56Z",
      "noLongerDetectedAt": "2023-11-07T05:31:56Z",
      "noLongerDetectedReason": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "naturalLanguageRuleEvaluationId": "<string>",
      "naturalLanguageRuleViolationId": "<string>",
      "naturalLanguageRuleViolation": {
        "id": "<string>",
        "ruleId": "<string>",
        "title": "<string>",
        "description": "<string>",
        "confidence": 123,
        "rule": {
          "id": "<string>",
          "name": "<string>"
        }
      },
      "codeScan": {
        "id": "<string>",
        "scanTargetBranchCommitSha": "<string>"
      },
      "stateChangeAuthor": "<string>",
      "falsePositiveReason": "<string>",
      "patch": {
        "id": "<string>",
        "prLink": "<string>",
        "prTitle": "<string>",
        "prDescription": "<string>",
        "gitDiff": "<string>",
        "pullRequestStatus": "<string>",
        "validated": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    }
  ],
  "totalCount": 123,
  "totalCountAllCategories": 123,
  "categoryCounts": {
    "open": 123,
    "patched": 123,
    "falsePositive": 123,
    "archived": 123,
    "processing": 123,
    "silenced": 123,
    "closed": 123
  },
  "currentPage": 123,
  "pageSize": 123
}

Authorizations

X-ZeroPath-API-Token-Id
string
header
required
X-ZeroPath-API-Token-Secret
string
header
required

Body

application/json
organizationId
string
page
integer
default:1
Required range: x >= 1
pageSize
integer
default:10
Required range: x >= 1
searchQuery
string
severities
object
sortBy
enum<string>
default:score
Available options:
createdAt,
severity,
score
sortOrder
enum<string>
default:desc
Available options:
asc,
desc
languages
string[]
vulnerabilityClasses
string[]
repositoryIds
string[]
projectId
string
scanId
string
codeScanTypes
enum<string>[]
types
enum<string>[]
getCounts
boolean
returnAll
boolean
ruleId
string

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

Response

Successful response

issues
object[]
totalCount
integer
totalCountAllCategories
integer
categoryCounts
object
currentPage
integer
pageSize
integer