Scans

List

Retrieves a list of scans with optional filtering and pagination

post/api/v1/scans

Request

  • Base URL
    https://zeropath.com
  • Auth
    API key in header X-ZeroPath-API-Token-Id and API key in header X-ZeroPath-API-Token-Secret

Request body

organizationIdstring required

Organization ID to list scans for

pagenumber

Page number for pagination

pageSizenumber

Number of items per page

querystring

Optional search query to filter scans

repositoryIdsstring[]

Filter scans to specific repositories

status'processing' | 'errored' | 'finished'

Filter scans by status

scanType'FullScan' | 'PrScan'

Filter by scan type

sortBy'createdAt' | 'updatedAt'

Field to sort results by

sortOrder'asc' | 'desc'

Order to sort results in

returnEphemeralboolean

Whether to include ephemeral scans in results

Response

List of scans

totalCountnumber

Total number of scans matching the query

Changes

No recorded changes to this operation across all 1 revision of this API.