---
title: "GET /volumes/{name}"
method: GET
path: "/volumes/{name}"
---

# GET /volumes/{name}

`GET /volumes/{name}`

Inspect a volume

## Path parameters

- `name` string, required

## Response `200`

The request has succeeded.

- Volume
  - `Name` string, required — Name of the volume.
  - `Driver` string, required — Name of the volume driver used by the volume.
  - `Mountpoint` string, required — Mount path of the volume on the host.
  - `CreatedAt` string, date-time — Date/Time the volume was created.
  - `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.
  - `Labels` object, required — User-defined key/value metadata.
  - `Scope` 'local' | 'global', required — The level at which the volume exists. Either `global` for cluster-wide, or `local` for machine level.
  - `ClusterVolume` ClusterVolume — Options and information specific to, and only present on, Swarm CSI cluster volumes.
    - `ID` string — The Swarm ID of this volume. Because cluster volumes are Swarm objects, they have an ID, unlike non-cluster volumes. This ID can be used to refer to the Volume instead of the name.
    - `Version` ObjectVersion — The version number of the object such as node, service, etc. This is needed to avoid conflicting writes. The client must send the version number along with the modified specification when updating these objects. This approach ensures safe concurrency and determinism in that the change on the object may not be applied if the version number has changed from the last read. In other words, if two update requests specify the same base version, only one of the requests can succeed. As a result, two separate update requests that happen at the same time will not unintentionally overwrite each other.
      - `Index` integer
    - `CreatedAt` string, date-time
    - `UpdatedAt` string, date-time
    - `Spec` ClusterVolumeSpec — Cluster-specific options used to create the volume.
      - `Group` string — Group defines the volume group of this volume. Volumes belonging to the same group can be referred to by group name when creating Services. Referring to a volume by group instructs Swarm to treat volumes in that group interchangeably for the purpose of scheduling. Volumes with an empty string for a group technically all belong to the same, emptystring group.
      - `AccessMode` object — Defines how the volume is used by tasks.
        - `Scope` 'single' | 'multi'
        - `Sharing` 'none' | 'readonly' | 'onewriter' | 'all'
        - `MountVolume` object
        - `Secrets` object[]
          - `Key` string
          - `Secret` string
        - `AccessibilityRequirements` object
          - `Requisite` object[]
          - `Preferred` object[]
        - `CapacityRange` object
          - `RequiredBytes` integer
          - `LimitBytes` integer
        - `Availability` 'active' | 'pause' | 'drain'
    - `Info` object — Information about the global status of the volume.
      - `CapacityBytes` integer
      - `VolumeContext` object
      - `VolumeID` string
      - `AccessibleTopology` object[]
    - `PublishStatus` object[] — The status of the volume as it pertains to its publishing and use on specific nodes
      - `NodeID` string
      - `State` 'pending-publish' | 'published' | 'pending-node-unpublish' | 'pending-controller-unpublish'
      - `PublishContext` object
  - `Options` object, required — The driver specific options used when creating the volume.
  - `UsageData` object, nullable — Usage details about the volume. This information is used by the `GET /system/df` endpoint, and omitted in other endpoints.
    - `Size` integer, required
    - `RefCount` integer, required

## Changes

- **2026-02-14** `31f80d10d31a` — 3 breaking, 9 info
  - the `ClusterVolume/CreatedAt` response's property type/format changed from `string`/`dateTime` to `string`/`date-time` for status `200`
  - the `ClusterVolume/UpdatedAt` response's property type/format changed from `string`/`dateTime` to `string`/`date-time` for status `200`
  - the `CreatedAt` response's property type/format changed from `string`/`dateTime` to `string`/`date-time` for status `200`
  - api tag `Volume` removed
  - …8 more

[Change history](https://skmtc.dev/hexlet/apis/docker-engine-api/changes/volumes/:name/get.md)

---

[API](https://skmtc.dev/hexlet/apis/docker-engine-api.md) · [All operations](https://skmtc.dev/hexlet/apis/docker-engine-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/hexlet/docker-engine-api/revisions/7dbd508c79cf/schema)