---
title: "List pools"
method: GET
path: "/pools"
tags: ["Pool"]
---

# List pools

`GET /pools`

List of pools that match the query.

## Response `200`

Success

- Pool[]
  - `ID` string — Pool unique ID.
  - `Name` string, required — Pool name.
  - `Description` string — Pool description.
  - `Default` boolean — Default determines whether this pool is the default if a volume is provisioned without a pool specified. There can only be one default pool.
  - `DefaultDriver` string — DefaultDriver specifies the storage driver to use by default if there are multiple drivers in the pool and no driver was specified in the provisioning request or assigned by rules. If no driver was specified and no default set, driver weight is used to determine the default.
  - `ControllerNames` string[] — ControllerNames is a list of controller names that are participating in the storage pool.
  - `DriverNames` string[] — DriverNames is a list of backend storage drivers that are available in the storage pool.
  - `DriverInstances` DriverInstances — DriverInstances shows the internal configuration and state of each driver on all the nodes in the pool. Data within DriverInstances can not be modified directly.
    - `ID` string — Instance unique ID.
    - `Name` string — Instance name.
    - `Description` string — Instance description.
    - `Active` boolean — Flag describing whether the template is active.
    - `Config` object — Config is JSON struct that is passed directly to the driver. There is no specific format, and the driver is responsible for validation.
    - `Labels` object — Labels define a list of labels that describe the driver instance. These are inherited from the pool when the driver instance is created.
    - `ControllerName` string — ControllerName specifies the controller that this instance is running on.
    - `PoolID` string — PoolID refers to the pool that this driver instance relates to.
    - `DriverName` string — DriverName specifies which capacity driver this is an instance of.
    - `CapacityStats` CapacityStats — CapacityStats is used to report capacity statistics on pools and controllers.
      - `TotalCapacityBytes` integer — TotalCapacityBytes is the object's total capacity in bytes.
      - `AvailableCapacityBytes` integer — AvailableCapacityBytes is the object's available capacity in bytes.
      - `ProvisionedCapacityBytes` integer — ProvisionedCapacityBytes is the object's provisioned capacity in bytes.
  - `Active` boolean — Flag describing whether rule is active.
  - `CapacityStats` CapacityStats — CapacityStats is used to report capacity statistics on pools and controllers.
    - `TotalCapacityBytes` integer — TotalCapacityBytes is the object's total capacity in bytes.
    - `AvailableCapacityBytes` integer — AvailableCapacityBytes is the object's available capacity in bytes.
    - `ProvisionedCapacityBytes` integer — ProvisionedCapacityBytes is the object's provisioned capacity in bytes.
  - `Labels` object — Labels define a list of labels that describe the pool.

## Other responses

- `500` — Server error

---

[API](https://skmtc.dev/kubeup/apis/storageos-api.md) · [All operations](https://skmtc.dev/kubeup/apis/storageos-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/kubeup/storageos-api/revisions/c1808b25d8d6/schema)