ZEzeropath
Container Scanning

Get a container scan

Retrieve a single container scan by ID, including its ordered image layers (layerIndex ascending), finding count, and detected/recommended base-image fields.

post/api/v2/containerScans/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

organizationIdstring

Organization ID (optional).

containerScanIdstring required

ID of the container scan to retrieve.

Response

Container scan retrieved

idstring required
containerImageIdstring required
repositoryIdstring required
imageRefstring required
imageDigeststring nullable
imageSizeBytesnumber nullable
imageCreatedAtstring date-time nullable

When the image was built (the image's own creation date); null when unknown.

status'IMAGE_PULL' | 'LAYER_ANALYSIS' | 'VULN_DETECTION' | 'SUCCEEDED' | 'FAILED' required
erroredboolean required

True when the scan failed (status === FAILED). A failed scan is terminal: stop polling. The DB CHECK ((status = 'FAILED') = (genericErrorId IS NOT NULL)) guarantees this flag equals (status === FAILED) exactly.

detectedBaseImageRefstring nullable
recommendedBaseImageRefstring nullable
recommendedBaseImageVulnReductionnumber nullable
findingsCountnumber required
createdAtstring date-time required
updatedAtstring date-time required

Changes

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