Docker Engine API
  1. Volume
Docker Engine API
  • System
    • Ping
      GET
    • Check auth configuration
      POST
    • Monitor events
      GET
    • Get system information
      GET
    • Get data usage information
      GET
    • Get version
      GET
  • Image
    • Build an image
      POST
    • Delete builder cache
      POST
    • Create a new image from a container
      POST
    • Create an image
      POST
    • Export several images
      GET
    • List Images
      GET
    • Import images
      POST
    • Delete unused images
      POST
    • Search images
      GET
    • Remove an image
      DELETE
    • Export an image
      GET
    • Get the history of an image
      GET
    • Inspect an image
      GET
    • Push an image
      POST
    • Tag an image
      POST
  • Config
    • List configs
      GET
    • Create a config
      POST
    • Delete a config
      DELETE
    • Inspect a config
      GET
    • Update a Config
      POST
  • Container
    • Create a container
    • List containers
    • Delete stopped containers
    • Remove a container
    • Get an archive of a filesystem resource in a container
    • Get information about files in a container
    • Extract an archive of files or folders to a directory in a container
    • Attach to a container
    • Attach to a container via a websocket
    • Get changes on a container’s filesystem
    • Export a container
    • Inspect a container
    • Kill a container
    • Get container logs
    • Pause a container
    • Rename a container
    • Resize a container TTY
    • Restart a container
    • Start a container
    • Get container stats based on resource usage
    • Stop a container
    • List processes running inside a container
    • Unpause a container
    • Update a container
    • Wait for a container
  • Exec
    • Create an exec instance
    • Inspect an exec instance
    • Resize an exec instance
    • Start an exec instance
  • Distribution
    • Get image information from the registry
  • Network
    • List networks
    • Create a network
    • Delete unused networks
    • Remove a network
    • Inspect a network
    • Connect a container to a network
    • Disconnect a container from a network
  • Node
    • List nodes
    • Delete a node
    • Inspect a node
    • Update a node
  • Plugin
    • List plugins
    • Create a plugin
    • Get plugin privileges
    • Install a plugin
    • Remove a plugin
    • Disable a plugin
    • Enable a plugin
    • Inspect a plugin
    • Push a plugin
    • Configure a plugin
    • Upgrade a plugin
  • Secret
    • List secrets
    • Create a secret
    • Delete a secret
    • Inspect a secret
    • Update a Secret
  • Service
    • List services
    • Create a service
    • Delete a service
    • Inspect a service
    • Get service logs
    • Update a service
  • Session (experimental)
    • Initialize interactive session
  • Swarm
    • Inspect swarm
    • Initialize a new swarm
    • Join an existing swarm
    • Leave a swarm
    • Unlock a locked manager
    • Get the unlock key
    • Update a swarm
  • Task
    • List tasks
    • Inspect a task
  • Volume
    • List volumes
      GET
    • Create a volume
      POST
    • Delete unused volumes
      POST
    • Remove a volume
      DELETE
    • Inspect a volume
      GET
  • Get task logs
    GET
  1. Volume

Create a volume

/v1.33
/v1.33
/v1.33
/v1.33
POST
/volumes/create
Volume
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/v1.33/volumes/create' \
--header 'Content-Type: application/json' \
--data-raw '{
    "Driver": "custom",
    "Labels": {
        "com.example.some-label": "some-value",
        "com.example.some-other-label": "some-other-value"
    },
    "Name": "tardis"
}'
Response Response Example
201 - Example 1
{
    "CreatedAt": "2016-06-07T20:31:11.853781916Z",
    "Driver": "custom",
    "Labels": {
        "com.example.some-label": "some-value",
        "com.example.some-other-label": "some-other-value"
    },
    "Mountpoint": "/var/lib/docker/volumes/tardis",
    "Name": "tardis",
    "Scope": "local",
    "Status": {
        "hello": "world"
    }
}

Request

Body Params application/json
Driver
string 
optional
Name of the volume driver to use.
Default:
local
DriverOpts
object 
optional
A mapping of driver options and values. These options are passed directly to the driver and are driver specific.
Additional properties
string 
optional
Labels
object 
optional
User-defined key/value metadata.
Additional properties
string 
optional
Name
string 
optional
The new volume's name. If not specified, Docker generates a name.
Examples

Responses

🟢201The volume was created successfully
application/json
Body
CreatedAt
string <dateTime>
optional
Date/Time the volume was created.
Driver
string 
required
Name of the volume driver used by the volume.
Labels
object 
required
User-defined key/value metadata.
Additional properties
string 
optional
Mountpoint
string 
required
Mount path of the volume on the host.
Name
string 
required
Name of the volume.
Options
object 
required
The driver specific options used when creating the volume.
Additional properties
string 
optional
Scope
enum<string> 
required
The level at which the volume exists. Either global for cluster-wide, or local for machine level.
Allowed values:
localglobal
Default:
local
Status
object 
optional
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.
Additional properties
object 
optional
UsageData
object  | null 
optional
Usage details about the volume. This information is used by the
GET /system/df endpoint, and omitted in other endpoints.
RefCount
integer 
required
The number of containers referencing this volume. This field
is set to -1 if the reference-count is not available.
Default:
-1
Size
integer 
required
Amount of disk space used by the volume (in bytes). This information
is only available for volumes created with the "local" volume
driver. For volumes created with other volume drivers, this field
is set to -1 ("not available")
Default:
-1
🔴500Server error
Modified at 2022-09-10 17:56:07
Previous
List volumes
Next
Delete unused volumes
Built with