HEhexlet
Volume

List volumes

Changed on
get/volumes

Request

  • Base URL
    /v1.57 (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    none declared

Query parameters

filtersstring json

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.

Response

Summary volume data that matches the query

Warningsstring[]

Warnings that occurred when fetching the list of volumes.

Example response

{
  "Volumes": [
    {
      "Name": "tardis",
      "Driver": "custom",
      "Mountpoint": "/var/lib/docker/volumes/tardis",
      "CreatedAt": "2016-06-07T20:31:11.853781916Z",
      "Status": {
        "hello": "world"
      },
      "Labels": {
        "com.example.some-label": "some-value",
        "com.example.some-other-label": "some-other-value"
      },
      "Scope": "local",
      "ClusterVolume": {
        "Version": {
          "Index": 373531
        }
      },
      "Options": {
        "device": "tmpfs",
        "o": "size=100m,uid=1000",
        "type": "tmpfs"
      }
    }
  ],
  "Warnings": []
}

Changes

  • 6df97b60796cRevision changes
    • breaking

      removed the media type application/json for the response with the status

    • info

      api tag Volume added

    • info

      added the non-success response with the status

  • 31f80d10d31aRevision changes
    • breaking

      the /// response's property format changed from dateTime to date-time for status

    • breaking

      the /// response's property format changed from dateTime to date-time for status

    • breaking

      the // response's property format changed from dateTime to date-time for status

    • info

      api tag Volume removed

    • info

      for the query request parameter filters, the format was generalized from json to no format

    • info

      removed the non-success response with the status

    • info

      the response's property default value active was removed for the status

    • info

      the response's property default value -1 was removed for the status

    • info

      the response's property default value local was removed for the status

    • info

      the response's property default value single was removed for the status

    • info

      the response's property default value none was removed for the status

    • info

      the response's property default value -1 was removed for the status