POST
/
api
/
v1
/
issues
/
get
Get issue
curl --request POST \
  --url https://zeropath.com/api/v1/issues/get \
  --header 'Content-Type: application/json' \
  --header 'X-ZeroPath-API-Token-Id: <api-key>' \
  --header 'X-ZeroPath-API-Token-Secret: <api-key>' \
  --data '{
  "issueId": "<string>",
  "organizationId": "<string>"
}'
{
  "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"
  }
}

Authorizations

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

Body

application/json
issueId
string
required
organizationId
string

Response

Successful response

id
string
required
repositoryId
string
required
status
enum<string>
required
Available options:
open,
patched,
falsePositive,
archived,
processing,
silenced
generatedTitle
string
required
generatedDescription
string
required
language
string
required
vulnClass
string
required
cwes
string[]
required
vulnCategory
enum<string>
required
Available options:
SAST,
SCA,
IAC,
SECRETS,
SMART_CONTRACT
severity
integer
required
affectedFile
string
required
sastCodeSegment
string
required
startLine
integer
required
endLine
integer
required
isPrBlocked
boolean
required
triagePhase
enum<string>
required
Available options:
VulnerabilityValidation,
CodeGeneration,
QA,
Finished,
LowSeverity,
FinishedNoCode
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
repositoryName
string
businessLogicScenario
string
confidence
integer
score
integer
startColumn
integer
endColumn
integer
validated
enum<string> | null
Available options:
CONFIRMED,
DISCONFIRMED,
UNKNOWN
validationSecurityAssessment
string | null
unpatchable
boolean | null
unpatchableReason
string | null
archivedAt
string<date-time> | null
noLongerDetectedAt
string<date-time> | null
noLongerDetectedReason
string | null
naturalLanguageRuleEvaluationId
string | null

ID of the natural language rule evaluation that found this issue (if applicable)

naturalLanguageRuleViolationId
string | null

ID of the natural language rule violation that found this issue (if applicable)

naturalLanguageRuleViolation
object | null

Natural language rule violation details if this issue was found by a custom rule

codeScan
object
stateChangeAuthor
string
falsePositiveReason
string | null
patch
object | null