---
title: "GET /osd-volumes"
method: GET
path: "/osd-volumes"
tags: ["volume"]
---

# GET /osd-volumes

`GET /osd-volumes`

Enumerate all volumes

## Query parameters

- `Name` string
- `VolumeID` string, uuid

## Response `200`

an array of volumes

- Volume[]
  - `CreatedAt` string — Date/Time the volume was created.
  - `Driver` string, required — Name of the volume driver used by the volume.
  - `Labels` object, required — User-defined key/value metadata.
  - `Mountpoint` string, required — Mount path of the volume on the host.
  - `Name` string, required — Name of the volume.
  - `Options` object, required — The driver specific options used when creating the volume.
  - `Scope` string, required — The level at which the volume exists. Either `global` for cluster-wide, or `local` for machine level.
  - `Status` object — Low-level details about the volume, provided by the volume driver. Details are returned as a map with key/value pairs: `{"key":"value","key2":"value2"}`. The `Status` field is optional, and is omitted if the volume driver does not support this feature.
  - `UsageData` VolumeUsageData — VolumeUsageData Usage details about the volume. This information is used by the `GET /system/df` endpoint, and omitted in other endpoints.
    - `RefCount` integer, required — The number of containers referencing this volume. This field is set to `-1` if the reference-count is not available.
    - `Size` integer, required — Amount of disk space used by the volume (in bytes). This information is only available for volumes created with the `"local"` volume driver. For volumes created with other volume drivers, this field is set to `-1` ("not available")

## Changes

- **2018-02-22** `ed1f944f48d5` — 1 info
  - api tag `enumerate` removed
- **2017-12-05** `d79082f863d1` — 1 info
  - api tag `enumerate` added

[Change history](https://skmtc.dev/libopenstorage/apis/osd-api/changes/osd-volumes/get.md)

---

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