Sign in

v1

latestOpenAPI 3.0.02026-07-1410578280.2 KB
Volume

Inspect a volume

get/volumes/{name}

Path parameters

namestring required

Volume name or ID

Response

No error

CreatedAtstring dateTime

Date/Time the volume was created.

Driverstring required

Name of the volume driver used by the volume.

Labelsobject required

User-defined key/value metadata.

Mountpointstring required

Mount path of the volume on the host.

Namestring required

Name of the volume.

Optionsobject required

The driver specific options used when creating the volume.

Scope'local' | 'global' required

The level at which the volume exists. Either global for cluster-wide, or local for machine level.

Statusobject

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.

Example response

{
  "CreatedAt": "2016-06-07T20:31:11.853781916Z",
  "Driver": "custom",
  "Labels": {
    "com.example.some-label": "some-value",
    "com.example.some-other-label": "some-other-value"
  },
  "Mountpoint": "/var/lib/docker/volumes/tardis",
  "Name": "tardis",
  "Scope": "local",
  "Status": {
    "hello": "world"
  }
}