Docker Engine API
  1. Volume
Docker Engine API
  • System
    • Ping
      GET
    • Check auth configuration
      POST
    • Monitor events
      GET
    • Get system information
      GET
    • Get data usage information
      GET
    • Get version
      GET
  • Image
    • Build an image
      POST
    • Delete builder cache
      POST
    • Create a new image from a container
      POST
    • Create an image
      POST
    • Export several images
      GET
    • List Images
      GET
    • Import images
      POST
    • Delete unused images
      POST
    • Search images
      GET
    • Remove an image
      DELETE
    • Export an image
      GET
    • Get the history of an image
      GET
    • Inspect an image
      GET
    • Push an image
      POST
    • Tag an image
      POST
  • Config
    • List configs
      GET
    • Create a config
      POST
    • Delete a config
      DELETE
    • Inspect a config
      GET
    • Update a Config
      POST
  • Container
    • Create a container
    • List containers
    • Delete stopped containers
    • Remove a container
    • Get an archive of a filesystem resource in a container
    • Get information about files in a container
    • Extract an archive of files or folders to a directory in a container
    • Attach to a container
    • Attach to a container via a websocket
    • Get changes on a container’s filesystem
    • Export a container
    • Inspect a container
    • Kill a container
    • Get container logs
    • Pause a container
    • Rename a container
    • Resize a container TTY
    • Restart a container
    • Start a container
    • Get container stats based on resource usage
    • Stop a container
    • List processes running inside a container
    • Unpause a container
    • Update a container
    • Wait for a container
  • Exec
    • Create an exec instance
    • Inspect an exec instance
    • Resize an exec instance
    • Start an exec instance
  • Distribution
    • Get image information from the registry
  • Network
    • List networks
    • Create a network
    • Delete unused networks
    • Remove a network
    • Inspect a network
    • Connect a container to a network
    • Disconnect a container from a network
  • Node
    • List nodes
    • Delete a node
    • Inspect a node
    • Update a node
  • Plugin
    • List plugins
    • Create a plugin
    • Get plugin privileges
    • Install a plugin
    • Remove a plugin
    • Disable a plugin
    • Enable a plugin
    • Inspect a plugin
    • Push a plugin
    • Configure a plugin
    • Upgrade a plugin
  • Secret
    • List secrets
    • Create a secret
    • Delete a secret
    • Inspect a secret
    • Update a Secret
  • Service
    • List services
    • Create a service
    • Delete a service
    • Inspect a service
    • Get service logs
    • Update a service
  • Session (experimental)
    • Initialize interactive session
  • Swarm
    • Inspect swarm
    • Initialize a new swarm
    • Join an existing swarm
    • Leave a swarm
    • Unlock a locked manager
    • Get the unlock key
    • Update a swarm
  • Task
    • List tasks
    • Inspect a task
  • Volume
    • List volumes
      GET
    • Create a volume
      POST
    • Delete unused volumes
      POST
    • Remove a volume
      DELETE
    • Inspect a volume
      GET
  • Get task logs
    GET
  1. Volume

List volumes

/v1.33
/v1.33
/v1.33
/v1.33
GET
/volumes
Volume
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/v1.33/volumes'
Response Response Example
200 - response
{
    "Volumes": [
        {
            "CreatedAt": "2017-07-19T12:00:26Z",
            "Driver": "local",
            "Labels": {
                "com.example.some-label": "some-value",
                "com.example.some-other-label": "some-other-value"
            },
            "Mountpoint": "/var/lib/docker/volumes/tardis",
            "Name": "tardis",
            "Options": {
                "device": "tmpfs",
                "o": "size=100m,uid=1000",
                "type": "tmpfs"
            },
            "Scope": "local"
        }
    ],
    "Warnings": []
}

Request

Query Params
filters
string 
optional
JSON encoded value of the filters (a map[string][]string) to
process on the volumes list. Available filters:
dangling=<boolean> When set to true (or 1), returns all
volumes that are not in use by a container. When set to false
(or 0), only volumes that are in use by one or more
containers are returned.
driver=<volume-driver-name> Matches volumes based on their driver.
label=<key> or label=<key>:<value> Matches volumes based on
the presence of a label alone or a label and a value.
name=<volume-name> Matches all or part of a volume name.

Responses

🟢200Summary volume data that matches the query
application/json
Body
Volumes
array[object (Volume) {9}] 
required
List of volumes
CreatedAt
string <dateTime>
optional
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
enum<string> 
required
The level at which the volume exists. Either global for cluster-wide, or local for machine level.
Allowed values:
localglobal
Default:
local
Status
object 
optional
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
object  | null 
optional
Usage details about the volume. This information is used by the
GET /system/df endpoint, and omitted in other endpoints.
Warnings
array[string]
required
Warnings that occurred when fetching the list of volumes
🔴500Server error
Modified at 2022-09-10 17:56:07
Previous
Inspect a task
Next
Create a volume
Built with