---
title: "System summary"
method: GET
path: "/system/summary"
tags: ["System"]
---

# System summary

`GET /system/summary`

## Request

- Base URL: `/v1` (relative, and the document was published on a file host, not at the API’s origin)
- URL: `/v1/system/summary`
- Auth: none declared. Required headers: `X-Auth-Token`
- TypeScript: <https://skmtc.dev/neuvector/apis/neuvector-api/docs/system/summary/get.ts> (a function with typed inputs; its response is checked against the schema)

## Headers

- `X-Auth-Token` string, required

## Response `200`

Success

- RESTSystemSummaryData
  - `summary` RESTSystemSummary, required
    - `hosts` integer, required
    - `controllers` integer, required
    - `enforcers` integer, required
    - `disconnected_enforcers` integer, required
    - `workloads` integer, required
    - `running_workloads` integer, required
    - `running_pods` integer, required
    - `services` integer, required
    - `policy_rules` integer, required
    - `scanners` integer, required
    - `platform` string, required
    - `kube_version` string, required
    - `openshift_version` string, required
    - `cvedb_version` string, required
    - `cvedb_create_time` string, required
    - `component_versions` string[], required

---

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