NAME
API::Docker::Type::Volume - The body of the 200 response to GET /volumes/{name}
VERSION
version 0.004
DESCRIPTION
Generated from the Volume definition of spec/v1.51.yaml, which the swagger leaves undescribed. paths: says what it is: the body of the 200 response to GET /volumes/{name}, the body of the 201 response to POST /volumes/create and one entry of the Volumes field of the 200 response to GET /system/df.
name
Name of the volume. The swagger lists this field as required; nothing here enforces that, see "since is documentation" in API::Docker::Type.
driver
Name of the volume driver used by the volume. The swagger lists this field as required; nothing here enforces that, see "since is documentation" in API::Docker::Type.
mountpoint
Mount path of the volume on the host. The swagger lists this field as required; nothing here enforces that, see "since is documentation" in API::Docker::Type.
created_at
Date/Time the volume was created.
status
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. The keys are the caller's data and are never translated.
labels
User-defined key/value metadata. The keys are the caller's data and are never translated. The swagger lists this field as required; nothing here enforces that, see "since is documentation" in API::Docker::Type.
scope
The level at which the volume exists. Either global for cluster-wide, or local for machine level. The daemon defaults it to local. The swagger lists this field as required; nothing here enforces that, see "since is documentation" in API::Docker::Type.
cluster_volume
Options and information specific to, and only present on, Swarm CSI cluster volumes. See API::Docker::Type::ClusterVolume.
options
The driver specific options used when creating the volume. The keys are the caller's data and are never translated. The swagger lists this field as required; nothing here enforces that, see "since is documentation" in API::Docker::Type.
usage_data
Usage details about the volume. This information is used by the GET /system/df endpoint, and omitted in other endpoints. See API::Docker::Type::Volume::UsageData.
SUPPORT
Issues
Please report bugs and feature requests on GitHub at https://github.com/Getty/p5-api-docker/issues.
CONTRIBUTING
Contributions are welcome! Please fork the repository and submit a pull request.
AUTHOR
Torsten Raudssus <getty@cpan.org>
COPYRIGHT AND LICENSE
This software is copyright (c) 2026 by Torsten Raudssus <torsten@raudssus.de> https://raudssus.de/.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.