Type Alias: Volume ​
Volume:
object
Type declaration ​
| Name | Type | Description |
|---|---|---|
ClusterVolume? | ClusterVolume | - |
CreatedAt? | string | Date/Time the volume was created. |
Driver | string | Name of the volume driver used by the volume. |
Labels | object | User-defined key/value metadata. |
Mountpoint | string | Mount path of the volume on the host. |
Name | string | Name of the volume. |
Options | object | The driver specific options used when creating the volume. |
Scope | "local" | "global" | The level at which the volume exists. Either global for cluster-wide, or local for machine level. |
Status? | object | 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 | Usage details about the volume. This information is used by the GET /system/df endpoint, and omitted in other endpoints. |