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>",
"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>"
}
'import requests
url = "https://zeropath.com/api/v1/issues/search"
payload = {
"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>"
}
headers = {
"X-ZeroPath-API-Token-Id": "<api-key>",
"X-ZeroPath-API-Token-Secret": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-ZeroPath-API-Token-Id': '<api-key>',
'X-ZeroPath-API-Token-Secret': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
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>'
})
};
fetch('https://zeropath.com/api/v1/issues/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://zeropath.com/api/v1/issues/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-ZeroPath-API-Token-Id: <api-key>",
"X-ZeroPath-API-Token-Secret: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://zeropath.com/api/v1/issues/search"
payload := strings.NewReader("{\n \"organizationId\": \"<string>\",\n \"page\": 1,\n \"pageSize\": 10,\n \"searchQuery\": \"<string>\",\n \"sortBy\": \"score\",\n \"sortOrder\": \"desc\",\n \"languages\": [\n \"<string>\"\n ],\n \"vulnerabilityClasses\": [\n \"<string>\"\n ],\n \"repositoryIds\": [\n \"<string>\"\n ],\n \"projectId\": \"<string>\",\n \"scanId\": \"<string>\",\n \"codeScanTypes\": [\n \"FullScan\"\n ],\n \"types\": [\n \"open\"\n ],\n \"status\": [],\n \"getCounts\": true,\n \"returnAll\": true,\n \"ruleId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-ZeroPath-API-Token-Id", "<api-key>")
req.Header.Add("X-ZeroPath-API-Token-Secret", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://zeropath.com/api/v1/issues/search")
.header("X-ZeroPath-API-Token-Id", "<api-key>")
.header("X-ZeroPath-API-Token-Secret", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"organizationId\": \"<string>\",\n \"page\": 1,\n \"pageSize\": 10,\n \"searchQuery\": \"<string>\",\n \"sortBy\": \"score\",\n \"sortOrder\": \"desc\",\n \"languages\": [\n \"<string>\"\n ],\n \"vulnerabilityClasses\": [\n \"<string>\"\n ],\n \"repositoryIds\": [\n \"<string>\"\n ],\n \"projectId\": \"<string>\",\n \"scanId\": \"<string>\",\n \"codeScanTypes\": [\n \"FullScan\"\n ],\n \"types\": [\n \"open\"\n ],\n \"status\": [],\n \"getCounts\": true,\n \"returnAll\": true,\n \"ruleId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://zeropath.com/api/v1/issues/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-ZeroPath-API-Token-Id"] = '<api-key>'
request["X-ZeroPath-API-Token-Secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"organizationId\": \"<string>\",\n \"page\": 1,\n \"pageSize\": 10,\n \"searchQuery\": \"<string>\",\n \"sortBy\": \"score\",\n \"sortOrder\": \"desc\",\n \"languages\": [\n \"<string>\"\n ],\n \"vulnerabilityClasses\": [\n \"<string>\"\n ],\n \"repositoryIds\": [\n \"<string>\"\n ],\n \"projectId\": \"<string>\",\n \"scanId\": \"<string>\",\n \"codeScanTypes\": [\n \"FullScan\"\n ],\n \"types\": [\n \"open\"\n ],\n \"status\": [],\n \"getCounts\": true,\n \"returnAll\": true,\n \"ruleId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"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
}{
"error": "<string>"
}{
"error": "<string>"
}Issues
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 --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>"
}
'import requests
url = "https://zeropath.com/api/v1/issues/search"
payload = {
"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>"
}
headers = {
"X-ZeroPath-API-Token-Id": "<api-key>",
"X-ZeroPath-API-Token-Secret": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-ZeroPath-API-Token-Id': '<api-key>',
'X-ZeroPath-API-Token-Secret': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
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>'
})
};
fetch('https://zeropath.com/api/v1/issues/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://zeropath.com/api/v1/issues/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-ZeroPath-API-Token-Id: <api-key>",
"X-ZeroPath-API-Token-Secret: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://zeropath.com/api/v1/issues/search"
payload := strings.NewReader("{\n \"organizationId\": \"<string>\",\n \"page\": 1,\n \"pageSize\": 10,\n \"searchQuery\": \"<string>\",\n \"sortBy\": \"score\",\n \"sortOrder\": \"desc\",\n \"languages\": [\n \"<string>\"\n ],\n \"vulnerabilityClasses\": [\n \"<string>\"\n ],\n \"repositoryIds\": [\n \"<string>\"\n ],\n \"projectId\": \"<string>\",\n \"scanId\": \"<string>\",\n \"codeScanTypes\": [\n \"FullScan\"\n ],\n \"types\": [\n \"open\"\n ],\n \"status\": [],\n \"getCounts\": true,\n \"returnAll\": true,\n \"ruleId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-ZeroPath-API-Token-Id", "<api-key>")
req.Header.Add("X-ZeroPath-API-Token-Secret", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://zeropath.com/api/v1/issues/search")
.header("X-ZeroPath-API-Token-Id", "<api-key>")
.header("X-ZeroPath-API-Token-Secret", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"organizationId\": \"<string>\",\n \"page\": 1,\n \"pageSize\": 10,\n \"searchQuery\": \"<string>\",\n \"sortBy\": \"score\",\n \"sortOrder\": \"desc\",\n \"languages\": [\n \"<string>\"\n ],\n \"vulnerabilityClasses\": [\n \"<string>\"\n ],\n \"repositoryIds\": [\n \"<string>\"\n ],\n \"projectId\": \"<string>\",\n \"scanId\": \"<string>\",\n \"codeScanTypes\": [\n \"FullScan\"\n ],\n \"types\": [\n \"open\"\n ],\n \"status\": [],\n \"getCounts\": true,\n \"returnAll\": true,\n \"ruleId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://zeropath.com/api/v1/issues/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-ZeroPath-API-Token-Id"] = '<api-key>'
request["X-ZeroPath-API-Token-Secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"organizationId\": \"<string>\",\n \"page\": 1,\n \"pageSize\": 10,\n \"searchQuery\": \"<string>\",\n \"sortBy\": \"score\",\n \"sortOrder\": \"desc\",\n \"languages\": [\n \"<string>\"\n ],\n \"vulnerabilityClasses\": [\n \"<string>\"\n ],\n \"repositoryIds\": [\n \"<string>\"\n ],\n \"projectId\": \"<string>\",\n \"scanId\": \"<string>\",\n \"codeScanTypes\": [\n \"FullScan\"\n ],\n \"types\": [\n \"open\"\n ],\n \"status\": [],\n \"getCounts\": true,\n \"returnAll\": true,\n \"ruleId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"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
}{
"error": "<string>"
}{
"error": "<string>"
}Authorizations
Body
application/json
Required range:
x >= 1Required range:
x >= 1Free-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.
Show child attributes
Show child attributes
Filter by score range (severity × confidence). Applied additively with other filters.
Show child attributes
Show child attributes
Available options:
createdAt, severity, score, title, class, file, detected, patch Available options:
asc, desc Available options:
FullScan, PrScan Available options:
open, patched, falsePositive, notExploitable, archived, closed, silenced Filter issues by issue status
Available options:
PENDING_REVIEW, REVIEWING, PATCHING, NON_EXPLOITABLE, FALSE_POSITIVE, ACCEPTED_RISK, RESOLVED, BACKLOG, INFORMATIONAL Filter issues by custom rule ID - returns only issues that were found by the specified custom rule
Was this page helpful?
⌘I