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>",
  "scanType": "FullScan",
  "sortBy": "createdAt",
  "sortOrder": "asc",
  "getCounts": false,
  "returnAll": false,
  "showEphemeral": false
}'
{
  "codeScans": [
    {
      "name": "<string>",
      "githubRepositoryId": "<string>",
      "gitlabRepositoryId": "<string>",
      "bitbucketRepositoryId": "<string>",
      "status": "<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,
        "processing": 123
      },
      "finished": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "repositoryId": "<string>",
      "errorMessage": "<string>",
      "trigger": "<string>",
      "sastScan": {
        "id": "<string>",
        "error": "<string>"
      }
    }
  ],
  "totalCount": 123
}

Authorizations

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

Body

application/json
organizationId
string
page
number
default:1
pageSize
number
default:10
searchQuery
string
repositoryIds
string[]
projectId
string
scanId
string
scanType
enum<string>
Available options:
FullScan,
PrScan
sortBy
enum<string>
Available options:
createdAt,
updatedAt
sortOrder
enum<string>
Available options:
asc,
desc
getCounts
boolean
default:false
returnAll
boolean
default:false
showEphemeral
boolean
default:false

Response

List of scans

codeScans
object[]
totalCount
number