Sign in

v1

latestSwagger 2.02026-07-175684145.0 KB
Volume

Create a volume

post/volumes/create

Request body

Namestring

The new volume's name. If not specified, Pouch generates a name.

Driverstring

Name of the volume driver to use.

DriverOptsobject

A mapping of driver options and values. These options are passed directly to the driver and are driver specific.

Labelsobject

User-defined key/value metadata.

Example request

{
  "Name": "tardis",
  "Labels": {
    "com.example.some-label": "some-value",
    "com.example.some-other-label": "some-other-value"
  },
  "Driver": "custom"
}

Response

The volume was created successfully

Namestring

Name is the name of the volume.

Driverstring

Driver is the Driver name used to create the volume.

Mountpointstring

Mountpoint is the location on disk of the volume.

CreatedAtstring dateTime

Date/Time the volume was created.

Statusobject

Status provides low-level status information about the volume.

Labelsobject

Labels is metadata specific to the volume.

Scopestring

Scope describes the level at which the volume exists (e.g. global for cluster-wide or local for machine level)