latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-194240919.7 KB

7a8c7ea97213

Auth3

Cephfs21

CephfsMirror5

CephfsSnapshotClone1

CephFSSnapshotSchedule6

CephFSSubvolume8

CephfsSubvolumeGroup5

CephfsSubvolumeSnapshot4

Cluster7

ClusterConfiguration6

CrushRule4

Daemon2

ErasureCodeProfile4

FeatureTogglesEndpoint1

Grafana3

Hardware1

Health6

Host10

Iscsi2

IscsiTarget5

Logs1

MdsPerfCounter1

MgrModule6

MgrPerfCounter1

Monitor1

MonPerfCounter1

Motd2

Multi-cluster9

NFS-Ganesha6

NVMe-oF Gateway10

NVMe-oF SPDK3

NVMe-oF Subsystem5

NVMe-oF Subsystem Connection1

NVMe-oF Subsystem Host Allowlist7

NVMe-oF Subsystem Listener3

NVMe-oF Subsystem Namespace19

OSD20

OsdPerfCounter1

PerfCounters1

Pool6

Prometheus10

PrometheusNotifications1

Rbd10

RbdGroup7

RbdGroupSnapshot6

RbdMirroring2

RbdMirroringPoolBootstrap2

RbdMirroringPoolMode2

RbdMirroringPoolPeer5

RbdMirroringSummary2

RbdNamespace3

RbdSnapshot5

RbdTrash4

Report5

RGW5

RGW Topic Management4

RgwBucket17

RgwDaemon3

RgwMirrorPerfCounter1

RgwMultisite10

RgwPerfCounter1

RgwRealm8

RgwSite1

RgwUser17

RgwUserAccounts8

RgwZone11

RgwZonegroup10

Role6

Service10

Settings5

SMB17

Summary1

Task1

TcmuRunnerPerfCounter1

Telemetry2

Upgrade6

User5

UserChangePassword1

UserPasswordPolicy1

Health

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

get/api/health/snapshot

Response

fsidstring required

Cluster filesystem ID

num_hostsinteger required

Count of hosts

num_hosts_availableinteger required

Count of available hosts

num_rgw_gatewaysinteger required

Count of RGW gateway daemons running