---
title: "Get a quick overview of cluster health at a moment, analogous to the ceph status command in CLI."
method: GET
path: "/api/health/snapshot"
tags: ["Health"]
---

# Get a quick overview of cluster health at a moment, analogous to the ceph status command in CLI.

`GET /api/health/snapshot`

## Response `200`

OK

- object
  - `fsid` string, required — Cluster filesystem ID
  - `fsmap` object, required — Filesystem map details
    - `num_active` integer, required — Number of active mds
    - `num_standbys` integer, required — Standby MDS count
  - `health` object, required — Cluster health overview
    - `checks` object, required — Health checks keyed by name
      - `<check_name>` object, required — Individual health check object
        - `muted` boolean, required — Whether the check is muted
        - `severity` string, required — Health severity level
        - `summary` object, required — Summary details
          - `count` integer, required — Occurrence count
          - `message` string, required — Human-readable summary
    - `mutes` string[], required — List of muted check names
    - `status` string, required — Overall health status
  - `mgrmap` object, required — Manager map details
    - `num_active` integer, required — Number of active managers
    - `num_standbys` integer, required — Standby manager count
  - `monmap` object, required — Monitor map details
    - `num_mons` integer, required — Number of monitors
    - `quorum` integer[], required — List of monitors in quorum
  - `num_hosts` integer, required — Count of hosts
  - `num_hosts_available` integer, required — Count of available hosts
  - `num_iscsi_gateways` object, required — Iscsi gateways status
    - `down` integer, required — Count of iSCSI gateways not running
    - `up` integer, required — Count of iSCSI gateways running
  - `num_rgw_gateways` integer, required — Count of RGW gateway daemons running
  - `osdmap` object, required — OSD map details
    - `in` integer, required — Number of OSDs in
    - `num_osds` integer, required — Total OSD count
    - `up` integer, required — Number of OSDs up
  - `pgmap` object, required — Placement group map details
    - `bytes_total` integer, required — Total capacity in bytes
    - `bytes_used` integer, required — Used capacity in bytes
    - `num_pgs` integer, required — Total PG count
    - `num_pools` integer, required — Number of pools
    - `pgs_by_state` object[], required — List of PG counts by state
      - `count` integer, required — Count of PGs in this state
      - `state_name` string, required — Placement group state
    - `recovering_bytes_per_sec` integer, required — Total recovery in bytes

## Other responses

- `400` — Operation exception. Please check the response body for details.
- `401` — Unauthenticated access. Please login first.
- `403` — Unauthorized access. Please check your permissions.
- `500` — Unexpected error. Please check the response body for the stack trace.

---

[API](https://skmtc.net/ceph/apis/ceph-rest-api.md) · [All operations](https://skmtc.net/ceph/apis/ceph-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ceph/ceph-rest-api/versions/b03ae23c3806/schema)