Search issues

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.

POST /api/v1/issues/search

Search issues

cURL

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>",
  "sortBy": "score",
  "sortOrder": "desc",
  "languages": [
    "<string>"
  ],
  "vulnerabilityClasses": [
    "<string>"
  ],
  "repositoryIds": [
    "<string>"
  ],
  "projectId": "<string>",
  "scanId": "<string>",
  "codeScanTypes": [
    "FullScan"
  ],
  "types": [
    "open"
  ],
  "status": [],
  "getCounts": true,
  "returnAll": true,
  "ruleId": "<string>"
}
'

200

{
  "issues": [
    {
      "id": "<string>",
      "repositoryId": "<string>",
      "generatedTitle": "<string>",
      "generatedDescription": "<string>",
      "language": "<string>",
      "vulnClass": "<string>",
      "cwes": [
        "<string>"
      ],
      "severity": 123,
      "discoveryTool": "<string>",
      "codeScanId": "<string>",
      "affectedFile": "<string>",
      "sastCodeSegment": "<string>",
      "startLine": 123,
      "endLine": 123,
      "isPrBlocked": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "url": "<string>",
      "repositoryName": "<string>",
      "businessLogicScenario": "<string>",
      "confidence": 123,
      "score": 123,
      "startColumn": 123,
      "endColumn": 123,
      "validationSecurityAssessment": "<string>",
      "unpatchable": true,
      "unpatchableReason": "<string>",
      "unpatchableRemediationInstructions": "<string>",
      "archivedAt": "2023-11-07T05:31:56Z",
      "noLongerDetectedAt": "2023-11-07T05:31:56Z",
      "noLongerDetectedReason": "<string>",
      "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>",
      "closedBy": {
        "id": "<string>",
        "name": "<string>",
        "email": "<string>"
      },
      "falsePositiveReason": "<string>",
      "falsePositiveAt": "2023-11-07T05:31:56Z",
      "introducedBy": {
        "contributorId": "<string>",
        "userId": "<string>",
        "name": "<string>",
        "email": "<string>",
        "platform": "<string>",
        "username": "<string>",
        "profileUrl": "<string>",
        "profileImageUrl": "<string>",
        "lineStart": 123,
        "lineEnd": 123,
        "timestamp": "2023-11-07T05:31:56Z"
      },
      "scaVulnerabilityAlertingGroupId": "<string>",
      "scaReachabilityAnalyses": [
        {
          "id": "<string>",
          "title": "<string>",
          "description": "<string>",
          "confidence": 123,
          "severity": 123,
          "isFalsePositive": true,
          "falsePositiveReasoning": "<string>",
          "pocCode": "<string>",
          "vulnerabilityLocation": {
            "id": "<string>",
            "filePath": "<string>",
            "startLine": 123,
            "endLine": 123,
            "startColumn": 123,
            "endColumn": 123,
            "snippet": "<string>",
            "language": "<string>"
          },
          "cvssScore": {
            "id": "<string>",
            "cvssVector": "<string>",
            "severity": 123
          }
        }
      ],
      "patchAttemptErrorDuringScan": {
        "id": "<string>",
        "rawError": "<string>",
        "displayError": "<string>",
        "errorType": "<string>",
        "createdAt": "2023-11-07T05:31:56Z"
      },
      "prSubmissionErrorDuringScan": {
        "id": "<string>",
        "rawError": "<string>",
        "displayError": "<string>",
        "errorType": "<string>",
        "createdAt": "2023-11-07T05:31:56Z"
      },
      "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"
      },
      "detectedSecret": {
        "detectorName": "<string>",
        "detectorDescription": "<string>",
        "decoderName": "<string>",
        "rotationGuide": "<string>",
        "redactedSecret": "<string>",
        "verified": true
      }
    }
  ],
  "totalCount": 123,
  "totalCountAllCategories": 123,
  "categoryCounts": {
    "open": 123,
    "patched": 123,
    "falsePositive": 123,
    "notExploitable": 123,
    "archived": 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

Free-text filter matched against issue title, vulnerability class, and affected file path. A query that looks like an issue id — hex digits and dashes only, at least 4 hex digits — also matches the issue id as a prefix, so the full UUID, the short 8-character issue id, and any longer prefix all find the issue. Dashes and surrounding whitespace are ignored for id matching.

severities · object

Show child attributes

scores · object

Filter by score range (severity × confidence). Applied additively with other filters.

Show child attributes

sortBy · enum<string> · default: score

Available options: createdAt, severity, score, title, class, file, detected, patch

sortOrder · enum<string> · default: desc

Available options: asc, desc

languages · string[]

vulnerabilityClasses · string[]

repositoryIds · string[]

projectId · string

scanId · string

codeScanTypes · enum<string>[]

Available options: FullScan, PrScan

types · enum<string>[]

Available options: open, patched, falsePositive, notExploitable, archived, closed, silenced

status · enum<string>[]

Filter issues by issue status

Available options: PENDING_REVIEW, REVIEWING, PATCHING, NON_EXPLOITABLE, FALSE_POSITIVE, ACCEPTED_RISK, RESOLVED, BACKLOG, INFORMATIONAL

getCounts · boolean

returnAll · boolean

ruleId · string

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

Response

200

application/json

Successful response

issues · object[]

Show child attributes

totalCount · integer

totalCountAllCategories · integer

categoryCounts · object

Show child attributes

currentPage · integer

pageSize · integer