ZEzeropath
Scans

Get Scan

Retrieves a single scan by ID, supporting both CodeScan and standalone SCAScan types

post/api/v2/scans/get

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

scanIdstring required

ID of the scan to retrieve

organizationIdstring

Organization ID (optional)

Response

Scan retrieved successfully

namestring
githubRepositoryIdstring
gitlabRepositoryIdstring
bitbucketRepositoryIdstring
azureRepositoryIdstring
gerritRepositoryIdstring
genericGitRepositoryIdstring
cvsRepositoryIdstring
projectIdstring
applicationIdstring
scanIdstring required
prTargetBranchstring nullable
scanTargetBranchstring
codeScanType'FullScan' | 'PrScan' | 'SCAScan'
prTriggeredURLstring nullable
isStagedboolean
status'Scheduled' | 'Queued' | 'Running' | 'Errored' | 'Finished' | 'Cloning repository' | 'Scanning for vulnerabilities' | 'Generating patches' | 'Setting up repository' | 'Identifying application(s)' | 'Generating AST' | 'Identifying source(s)' | 'Detecting vulnerabilities' | 'Validating results'

Current status of the scan

statusNumnumber

Numeric status indicator (0-10, higher means more progress)

finishedboolean required
createdAtstring date-time required
updatedAtstring date-time required
scanFinishedAtstring date-time nullable
trigger'Scheduled' | 'Manual'
repositoryIdstring required
repositoryNamestring
errorMessagestring nullable
prBypassedAtboolean
scanType'code' | 'sca' required

Changes

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