Schema
Type:
object
Destination
Type:
string
/) where
the Source is mounted inside the container.All schema constraints and annotations
{
"description": "Destination is the path relative to the container root (`/`) where\nthe `Source` is mounted inside the container.\n",
"example": "/usr/share/nginx/html/",
"type": "string"
}Driver
Type:
string
All schema constraints and annotations
{
"description": "Driver is the volume driver used to create the volume (if it is a volume).\n",
"example": "local",
"type": "string"
}Mode
Type:
string
Mode is a comma separated list of options supplied by the user when creating the bind/volume mount.
The default is platform-specific ("z" on Linux, empty on Windows).
All schema constraints and annotations
{
"description": "Mode is a comma separated list of options supplied by the user when\ncreating the bind/volume mount.\n\nThe default is platform-specific (`\"z\"` on Linux, empty on Windows).\n",
"example": "z",
"type": "string"
}Name
Type:
string
Source
e.g., the volume name.All schema constraints and annotations
{
"description": "Name is the name reference to the underlying data defined by `Source`\ne.g., the volume name.\n",
"example": "myvolume",
"type": "string"
}Propagation
Type:
string
All schema constraints and annotations
{
"description": "Propagation describes how mounts are propagated from the host into the\nmount point, and vice-versa. Refer to the [Linux kernel documentation](https://www.kernel.org/doc/Documentation/filesystems/sharedsubtree.txt)\nfor details. This field is not used on Windows.\n",
"example": "",
"type": "string"
}RW
Type:
boolean
All schema constraints and annotations
{
"description": "Whether the mount is mounted writable (read-write).\n",
"example": true,
"type": "boolean"
}Source
Type:
string
Source location of the mount.
For volumes, this contains the storage location of the volume (within
/var/lib/docker/volumes/). For bind-mounts, and npipe, this contains
the source (host) part of the bind-mount. For tmpfs mount points, this
field is empty.
All schema constraints and annotations
{
"description": "Source location of the mount.\n\nFor volumes, this contains the storage location of the volume (within\n`/var/lib/docker/volumes/`). For bind-mounts, and `npipe`, this contains\nthe source (host) part of the bind-mount. For `tmpfs` mount points, this\nfield is empty.\n",
"example": "/var/lib/docker/volumes/myvolume/_data",
"type": "string"
}Type
The mount type:
binda mount of a file or directory from the host into the container.clustera Swarm cluster volume.imagean OCI image.npipea named pipe from the host into the container.tmpfsatmpfs.volumea docker volume with the givenName.
All constraints apply
Schema:
MountType
All schema constraints and annotations
{
"allOf": [
{
"$ref": "#/components/schemas/MountType"
}
],
"description": "The mount type:\n\n- `bind` a mount of a file or directory from the host into the container.\n- `cluster` a Swarm cluster volume.\n- `image` an OCI image.\n- `npipe` a named pipe from the host into the container.\n- `tmpfs` a `tmpfs`.\n- `volume` a docker volume with the given `Name`.\n",
"example": "volume"
}All schema constraints and annotations
{
"description": "MountPoint represents a mount point configuration inside the container.\nThis is used for reporting the mountpoints in use by a container.\n",
"properties": {
"Destination": {
"description": "Destination is the path relative to the container root (`/`) where\nthe `Source` is mounted inside the container.\n",
"example": "/usr/share/nginx/html/",
"type": "string"
},
"Driver": {
"description": "Driver is the volume driver used to create the volume (if it is a volume).\n",
"example": "local",
"type": "string"
},
"Mode": {
"description": "Mode is a comma separated list of options supplied by the user when\ncreating the bind/volume mount.\n\nThe default is platform-specific (`\"z\"` on Linux, empty on Windows).\n",
"example": "z",
"type": "string"
},
"Name": {
"description": "Name is the name reference to the underlying data defined by `Source`\ne.g., the volume name.\n",
"example": "myvolume",
"type": "string"
},
"Propagation": {
"description": "Propagation describes how mounts are propagated from the host into the\nmount point, and vice-versa. Refer to the [Linux kernel documentation](https://www.kernel.org/doc/Documentation/filesystems/sharedsubtree.txt)\nfor details. This field is not used on Windows.\n",
"example": "",
"type": "string"
},
"RW": {
"description": "Whether the mount is mounted writable (read-write).\n",
"example": true,
"type": "boolean"
},
"Source": {
"description": "Source location of the mount.\n\nFor volumes, this contains the storage location of the volume (within\n`/var/lib/docker/volumes/`). For bind-mounts, and `npipe`, this contains\nthe source (host) part of the bind-mount. For `tmpfs` mount points, this\nfield is empty.\n",
"example": "/var/lib/docker/volumes/myvolume/_data",
"type": "string"
},
"Type": {
"allOf": [
{
"$ref": "#/components/schemas/MountType"
}
],
"description": "The mount type:\n\n- `bind` a mount of a file or directory from the host into the container.\n- `cluster` a Swarm cluster volume.\n- `image` an OCI image.\n- `npipe` a named pipe from the host into the container.\n- `tmpfs` a `tmpfs`.\n- `volume` a docker volume with the given `Name`.\n",
"example": "volume"
}
},
"type": "object"
}