---
title: "Get a summary of the deployment for a Cribl product"
method: GET
path: "/products/{product}/summary"
tags: ["distributed"]
---

# Get a summary of the deployment for a Cribl product

`GET /products/{product}/summary`

Get a summary of the deployment for the specified Cribl product (Stream or Edge).<br/><br/>The summary includes a count of Worker Groups or Edge Fleets and resources such as Pipelines, Routes, Sources, and Destinations. For Distributed deployments, the summary also includes a count and statistics for Worker or Edge Nodes.

## Path parameters

- `product` 'stream' | 'edge', required

## Query parameters

- `offset` integer
- `limit` integer

## Response `200`

List of DistributedSummary objects.

- PaginatedDistributedSummary
  - `items` DistributedSummary[], required — The pre-limited items in the list of results
    - `groups` object, required — Resource counts for Worker Groups or Edge Fleets in the deployment summary.
      - `count` integer, required — Total number of Worker Groups or Edge Fleets.
      - `destinations` integer, required — Total number of Destinations.
      - `packs` integer, required — Total number of Packs.
      - `pipelines` integer, required — Total number of Pipelines.
      - `quickConnects` integer, required — Total number of QuickConnect configurations.
      - `routes` integer, required — Total number of Routes.
      - `sources` integer, required — Total number of Sources.
    - `workers` object — Worker or Edge Node counts and health statistics in the deployment summary.
      - `alive` integer, required — Total number of Worker or Edge Nodes that are connected with <code>healthy</code> status.
      - `confVersions` integer, required — Total number of unique configuration versions across all Worker or Edge Nodes.
      - `count` integer, required — Total number of Worker or Edge Nodes.
      - `disconnectedCount` integer, required — Total number of Worker or Edge Nodes in a disconnected state.
      - `groups` integer, required — Total number of distinct Worker Groups or Edge Fleets that the Workers or Edge Nodes belong to.
      - `softwareVersions` integer, required — Total number of unique Cribl software versions across all Worker or Edge Nodes.
      - `unhealthy` integer, required — Total number of Worker or Edge Nodes that are connected with a status other than <code>healthy</code>.
  - `count` integer, required — Number of items present in the items array
  - `offset` integer — Pagination offset. Returned when offset/limit query parameters are provided.
  - `limit` integer — Pagination limit. Returned when offset/limit query parameters are provided.
  - `totalCount` integer — Total number of items available. Returned when offset/limit query parameters are provided.

## Other responses

- `400` — Failed validation or malformed input if the product is not "stream" or "edge"
- `401` — Authentication failed (missing or invalid credentials or Bearer token).
- `403` — Not authorized or licensed to perform this action.
- `500` — Unexpected server error.

## Changes

- **2026-07-21** `e9bef570d106` — 11 info
  - added the new optional `query` request parameter `limit`
  - added the new optional `query` request parameter `offset`
  - added the media type `application/json` for the response with the status `401`
  - added the optional property `details` to the response with the `500` status
  - …7 more
- **2026-05-14** `484cda0ad459` — 1 breaking
  - the response property `items/items/workers` became optional for the status `200`
- **2026-03-06** `11df16b26c1d` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/criblio/apis/cribl-api-reference/changes/products/:product/summary/get.md)

---

[API](https://skmtc.dev/criblio/apis/cribl-api-reference.md) · [All operations](https://skmtc.dev/criblio/apis/cribl-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/criblio/cribl-api-reference/revisions/56cb25079271/schema)