Search or ask Docker

VolumeCreateRequest

VolumeCreateRequest schema in Docker Engine API 1.57.

View Markdown

Schema

Type: object

Volume configuration
ClusterVolumeSpec

Schema: ClusterVolumeSpec

Driver

Type: string

Name of the volume driver to use.
All schema constraints and annotations
{
  "default": "local",
  "description": "Name of the volume driver to use.",
  "example": "custom",
  "type": "string",
  "x-nullable": false
}
DriverOpts

Type: object

A mapping of driver options and values. These options are passed directly to the driver and are driver specific.
All schema constraints and annotations
{
  "additionalProperties": {
    "type": "string"
  },
  "description": "A mapping of driver options and values. These options are\npassed directly to the driver and are driver specific.\n",
  "example": {
    "device": "tmpfs",
    "o": "size=100m,uid=1000",
    "type": "tmpfs"
  },
  "type": "object"
}
Labels

Type: object

User-defined key/value metadata.
All schema constraints and annotations
{
  "additionalProperties": {
    "type": "string"
  },
  "description": "User-defined key/value metadata.",
  "example": {
    "com.example.some-label": "some-value",
    "com.example.some-other-label": "some-other-value"
  },
  "type": "object"
}
Name

Type: string

The new volume's name. If not specified, Docker generates a name.
All schema constraints and annotations
{
  "description": "The new volume's name. If not specified, Docker generates a name.\n",
  "example": "tardis",
  "type": "string",
  "x-nullable": false
}
All schema constraints and annotations
{
  "description": "Volume configuration",
  "properties": {
    "ClusterVolumeSpec": {
      "$ref": "#/components/schemas/ClusterVolumeSpec"
    },
    "Driver": {
      "default": "local",
      "description": "Name of the volume driver to use.",
      "example": "custom",
      "type": "string",
      "x-nullable": false
    },
    "DriverOpts": {
      "additionalProperties": {
        "type": "string"
      },
      "description": "A mapping of driver options and values. These options are\npassed directly to the driver and are driver specific.\n",
      "example": {
        "device": "tmpfs",
        "o": "size=100m,uid=1000",
        "type": "tmpfs"
      },
      "type": "object"
    },
    "Labels": {
      "additionalProperties": {
        "type": "string"
      },
      "description": "User-defined key/value metadata.",
      "example": {
        "com.example.some-label": "some-value",
        "com.example.some-other-label": "some-other-value"
      },
      "type": "object"
    },
    "Name": {
      "description": "The new volume's name. If not specified, Docker generates a name.\n",
      "example": "tardis",
      "type": "string",
      "x-nullable": false
    }
  },
  "title": "VolumeConfig",
  "type": "object",
  "x-go-name": "CreateRequest"
}