Skip to content
StratumStratum Docs

List storage pools (operator-only).

GET
/v1/storage-pools
Code sample: Shell / cURL
curl --request GET \
  --url https://stratum.example.com/v1/storage-pools \
  --header 'Authorization: Bearer <token>'

. Returns every known pool with its driver, owning node, capacity, health state, and the physical devices (PVs) backing it.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Storage pools.

Media typeapplication/json
object
items
required
Array<object>

A storage pool. For lvm-thin this is the install’s VG + thin pool on one node; capacity is refreshed by the 60s poller.

object
id
required

Stable surrogate id (pool-…)..

string
name
required
string
driver
required
string
Allowed values: lvm-thin ceph-rbd
nodeId
string
totalBytes
required
integer format: int64
usedBytes
required
integer format: int64
availableBytes
required
integer format: int64
state
required

missing: the backend no longer has the pool; see stateReason. Volumes cannot be placed in it. The next successful poll restores the real state.

string
Allowed values: healthy degraded full missing
stateReason

Why the pool is missing. Absent otherwise.

string
lastPolledAt
string format: date-time
devicePaths
required

Physical devices (PVs) backing the pool’s VG.

Array<string>
volumeGroup

The LVM volume group the pool lives in (lvm-thin only). The install’s default pool is named after its thin LV but lives in the configured VG, so read the VG from here, never from name. Absent for Ceph and until the pool’s node has polled it..

string

Example 

{
  "items": [
    {
      "driver": "lvm-thin",
      "state": "healthy"
    }
  ]
}