---
title: "Get the container dashboard overview"
method: POST
path: "/api/v2/containerImages/summary"
tags: ["Container Scanning"]
---

# Get the container dashboard overview

`POST /api/v2/containerImages/summary`

## Request

- Base URL: `https://zeropath.com`
- URL: `https://zeropath.com/api/v2/containerImages/summary`
- Auth: API key in header `X-ZeroPath-API-Token-Id` and API key in header `X-ZeroPath-API-Token-Secret`

Return an organization-wide overview of tracked container images for the Containers dashboard: headline image counts (total, monitored, scanning, failed), a findings-by-severity breakdown, base-image-upgrade opportunities (how many images can upgrade, the total findings that upgrading would remove, and the top opportunities), and the most-vulnerable images. Every finding figure is derived from each image's latest scan, so it agrees with the per-image list.

## Request body

- ContainerDashboardSummaryRequest: Input for the Containers dashboard overview. Returns organization-wide aggregates across every accessible image's latest scan.
  - `organizationId` string: Organization ID (optional).
  - `topListLimit` number: How many entries the most-vulnerable and base-image-upgrade top lists return.

## Response `200`

Overview retrieved

- ContainerDashboardSummaryResponse: Organization-wide container overview. Every finding figure is derived from each image's latest scan, so it agrees with the per-image list.
  - `images` object, required
    - `total` number, required: All tracked images the caller can see.
    - `monitored` number, required: Images with a recurring monitoring schedule set.
    - `scanning` number, required: Images whose latest scan is still in progress.
    - `failed` number, required: Images whose latest scan failed.
  - `findings` object, required
    - `total` number, required: Total findings across every image's latest scan.
    - `bySeverity` object, required: The total bucketed by qualitative severity label. Every label is always present (0 when none).
      - `Informational` number, required
      - `Low` number, required
      - `Medium` number, required
      - `High` number, required
      - `Critical` number, required
  - `baseImageUpgrades` object, required
    - `imagesWithUpgrade` number, required: Images whose latest scan recommends a base-image upgrade.
    - `totalFindingsRemovable` number, required: Total findings that adopting every recommended base image would remove.
    - `topByReduction` ContainerBaseImageUpgrade[], required: Highest-impact upgrade opportunities first.
      - `containerImageId` string, required
      - `imageRef` string, required
      - `detectedBaseImageRef` string, nullable, required: Currently detected base image, e.g. "node:18".
      - `recommendedBaseImageRef` string, required: Recommended replacement base image, e.g. "debian:12".
      - `vulnReduction` number, required: Number of findings removed by adopting the recommended base image (> 0).
  - `topImagesByFindingCount` ContainerImageFindingCount[], required: Most-vulnerable images first (zero-finding images excluded).
    - `containerImageId` string, required
    - `imageRef` string, required
    - `findingsCount` number, required

## Other responses

- `401`: Error Response

---

[API](https://skmtc.dev/zeropath/apis/zeropath-api.md) - [All operations](https://skmtc.dev/zeropath/apis/zeropath-api/llms.txt) - [OpenAPI document](https://skmtc.dev/zeropath/apis/zeropath-api/revisions/126e9c80ba0d?raw)