List scans

1 curl -X POST https://zeropath.com/api/v1/scans/list \ 2 -H "X-ZeroPath-API-Token-Id: <apiTokenId>" \ 3 -H "Content-Type: application/json" \ 4 -d '{}'

1 { 2 "codeScans": [ 3 { 4 "name": "name", 5 "githubRepositoryId": "githubRepositoryId", 6 "gitlabRepositoryId": "gitlabRepositoryId", 7 "bitbucketRepositoryId": "bitbucketRepositoryId", 8 "status": "status", 9 "projectId": "projectId", 10 "applicationId": "applicationId", 11 "scanId": "scanId", 12 "prTargetBranch": "prTargetBranch", 13 "scanTargetBranch": "scanTargetBranch", 14 "codeScanType": "codeScanType", 15 "prTriggeredURL": "prTriggeredURL", 16 "isStaged": true, 17 "codeScanFinished": true, 18 "finished": true, 19 "createdAt": "2024-01-15T09:30:00Z", 20 "updatedAt": "2024-01-15T09:30:00Z", 21 "repositoryId": "repositoryId", 22 "errorMessage": "errorMessage", 23 "trigger": "trigger" 24 } 25 ], 26 "totalCount": 1.1 27 }

Request

This endpoint expects an object.

organizationIdstringOptional

pagedoubleOptionalDefaults to 1

pageSizedoubleOptionalDefaults to 10

searchQuerystringOptional

repositoryIdslist of stringsOptional

projectIdstringOptional

scanIdstringOptional

scanTypeenumOptional

Allowed values:

sortByenumOptional

Allowed values:

sortOrderenumOptional

Allowed values:

getCountsbooleanOptionalDefaults to false

returnAllbooleanOptionalDefaults to false

showEphemeralbooleanOptionalDefaults to false

Response

List of scans

codeScanslist of objects or null

totalCountdouble or null

Headers

Request

Response

Errors