List scans
curl --request POST \
--url https://zeropath.com/api/v1/scans/list \
--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>",
"repositoryIds": [
"<string>"
],
"projectId": "<string>",
"scanId": "<string>",
"getCounts": false,
"returnAll": false,
"showEphemeral": false
}
'import requests
url = "https://zeropath.com/api/v1/scans/list"
payload = {
"organizationId": "<string>",
"page": 1,
"pageSize": 10,
"searchQuery": "<string>",
"repositoryIds": ["<string>"],
"projectId": "<string>",
"scanId": "<string>",
"getCounts": False,
"returnAll": False,
"showEphemeral": False
}
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>',
repositoryIds: ['<string>'],
projectId: '<string>',
scanId: '<string>',
getCounts: false,
returnAll: false,
showEphemeral: false
})
};
fetch('https://zeropath.com/api/v1/scans/list', 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/scans/list",
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>',
'repositoryIds' => [
'<string>'
],
'projectId' => '<string>',
'scanId' => '<string>',
'getCounts' => false,
'returnAll' => false,
'showEphemeral' => false
]),
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/scans/list"
payload := strings.NewReader("{\n \"organizationId\": \"<string>\",\n \"page\": 1,\n \"pageSize\": 10,\n \"searchQuery\": \"<string>\",\n \"repositoryIds\": [\n \"<string>\"\n ],\n \"projectId\": \"<string>\",\n \"scanId\": \"<string>\",\n \"getCounts\": false,\n \"returnAll\": false,\n \"showEphemeral\": false\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/scans/list")
.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 \"repositoryIds\": [\n \"<string>\"\n ],\n \"projectId\": \"<string>\",\n \"scanId\": \"<string>\",\n \"getCounts\": false,\n \"returnAll\": false,\n \"showEphemeral\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://zeropath.com/api/v1/scans/list")
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 \"repositoryIds\": [\n \"<string>\"\n ],\n \"projectId\": \"<string>\",\n \"scanId\": \"<string>\",\n \"getCounts\": false,\n \"returnAll\": false,\n \"showEphemeral\": false\n}"
response = http.request(request)
puts response.read_body{
"codeScans": [
{
"name": "<string>",
"githubRepositoryId": "<string>",
"gitlabRepositoryId": "<string>",
"bitbucketRepositoryId": "<string>",
"azureRepositoryId": "<string>",
"projectId": "<string>",
"applicationId": "<string>",
"scanId": "<string>",
"prTargetBranch": "<string>",
"scanTargetBranch": "<string>",
"codeScanType": "<string>",
"prTriggeredURL": "<string>",
"isStaged": true,
"codeScanFinished": true,
"issueCounts": {
"open": 123,
"patched": 123,
"falsePositive": 123,
"archived": 123
},
"finished": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"scanFinishedAt": "2023-11-07T05:31:56Z",
"repositoryId": "<string>",
"errorMessage": "<string>",
"trigger": "<string>",
"sastScan": {
"id": "<string>",
"error": "<string>"
}
}
],
"totalCount": 123
}{
"error": "<string>"
}Scans
List scans
POST
/
api
/
v1
/
scans
/
list
List scans
curl --request POST \
--url https://zeropath.com/api/v1/scans/list \
--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>",
"repositoryIds": [
"<string>"
],
"projectId": "<string>",
"scanId": "<string>",
"getCounts": false,
"returnAll": false,
"showEphemeral": false
}
'import requests
url = "https://zeropath.com/api/v1/scans/list"
payload = {
"organizationId": "<string>",
"page": 1,
"pageSize": 10,
"searchQuery": "<string>",
"repositoryIds": ["<string>"],
"projectId": "<string>",
"scanId": "<string>",
"getCounts": False,
"returnAll": False,
"showEphemeral": False
}
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>',
repositoryIds: ['<string>'],
projectId: '<string>',
scanId: '<string>',
getCounts: false,
returnAll: false,
showEphemeral: false
})
};
fetch('https://zeropath.com/api/v1/scans/list', 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/scans/list",
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>',
'repositoryIds' => [
'<string>'
],
'projectId' => '<string>',
'scanId' => '<string>',
'getCounts' => false,
'returnAll' => false,
'showEphemeral' => false
]),
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/scans/list"
payload := strings.NewReader("{\n \"organizationId\": \"<string>\",\n \"page\": 1,\n \"pageSize\": 10,\n \"searchQuery\": \"<string>\",\n \"repositoryIds\": [\n \"<string>\"\n ],\n \"projectId\": \"<string>\",\n \"scanId\": \"<string>\",\n \"getCounts\": false,\n \"returnAll\": false,\n \"showEphemeral\": false\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/scans/list")
.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 \"repositoryIds\": [\n \"<string>\"\n ],\n \"projectId\": \"<string>\",\n \"scanId\": \"<string>\",\n \"getCounts\": false,\n \"returnAll\": false,\n \"showEphemeral\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://zeropath.com/api/v1/scans/list")
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 \"repositoryIds\": [\n \"<string>\"\n ],\n \"projectId\": \"<string>\",\n \"scanId\": \"<string>\",\n \"getCounts\": false,\n \"returnAll\": false,\n \"showEphemeral\": false\n}"
response = http.request(request)
puts response.read_body{
"codeScans": [
{
"name": "<string>",
"githubRepositoryId": "<string>",
"gitlabRepositoryId": "<string>",
"bitbucketRepositoryId": "<string>",
"azureRepositoryId": "<string>",
"projectId": "<string>",
"applicationId": "<string>",
"scanId": "<string>",
"prTargetBranch": "<string>",
"scanTargetBranch": "<string>",
"codeScanType": "<string>",
"prTriggeredURL": "<string>",
"isStaged": true,
"codeScanFinished": true,
"issueCounts": {
"open": 123,
"patched": 123,
"falsePositive": 123,
"archived": 123
},
"finished": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"scanFinishedAt": "2023-11-07T05:31:56Z",
"repositoryId": "<string>",
"errorMessage": "<string>",
"trigger": "<string>",
"sastScan": {
"id": "<string>",
"error": "<string>"
}
}
],
"totalCount": 123
}{
"error": "<string>"
}Authorizations
Body
application/json
Available options:
FullScan, PrScan, SCAScan Available options:
createdAt, updatedAt Available options:
asc, desc Was this page helpful?
⌘I