summaryrefslogtreecommitdiff
path: root/docker/api/volume.py
diff options
context:
space:
mode:
Diffstat (limited to 'docker/api/volume.py')
-rw-r--r--docker/api/volume.py22
1 files changed, 22 insertions, 0 deletions
diff --git a/docker/api/volume.py b/docker/api/volume.py
index 5de089e..76565c7 100644
--- a/docker/api/volume.py
+++ b/docker/api/volume.py
@@ -114,6 +114,28 @@ class VolumeApiMixin(object):
url = self._url('/volumes/{0}', name)
return self._result(self._get(url), True)
+ @utils.minimum_version('1.25')
+ def prune_volumes(self, filters=None):
+ """
+ Delete unused volumes
+
+ Args:
+ filters (dict): Filters to process on the prune list.
+
+ Returns:
+ (dict): A dict containing a list of deleted volume IDs and
+ the amount of disk space reclaimed in bytes.
+
+ Raises:
+ :py:class:`docker.errors.APIError`
+ If the server returns an error.
+ """
+ params = {}
+ if filters:
+ params['filters'] = utils.convert_filters(filters)
+ url = self._url('/volumes/prune')
+ return self._result(self._post(url, params=params), True)
+
@utils.minimum_version('1.21')
def remove_volume(self, name, force=False):
"""