Docker Engine API
  1. Container
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
    • Delete builder cache
    • Create a new image from a container
    • Create an image
    • Export several images
    • List Images
    • Import images
    • Delete unused images
    • Search images
    • Remove an image
    • Export an image
    • Get the history of an image
    • Inspect an image
    • Push an image
    • Tag an image
  • Config
    • List configs
    • Create a config
    • Delete a config
    • Inspect a config
    • Update a Config
  • Container
    • Create a container
      POST
    • List containers
      GET
    • Delete stopped containers
      POST
    • Remove a container
      DELETE
    • Get an archive of a filesystem resource in a container
      GET
    • Get information about files in a container
      HEAD
    • Extract an archive of files or folders to a directory in a container
      PUT
    • Attach to a container
      POST
    • Attach to a container via a websocket
      GET
    • Get changes on a container’s filesystem
      GET
    • Export a container
      GET
    • Inspect a container
      GET
    • Kill a container
      POST
    • Get container logs
      GET
    • Pause a container
      POST
    • Rename a container
      POST
    • Resize a container TTY
      POST
    • Restart a container
      POST
    • Start a container
      POST
    • Get container stats based on resource usage
      GET
    • Stop a container
      POST
    • List processes running inside a container
      GET
    • Unpause a container
      POST
    • Update a container
      POST
    • Wait for a container
      POST
  • 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
    • Create a volume
    • Delete unused volumes
    • Remove a volume
    • Inspect a volume
  • Get task logs
    GET
  1. Container

Create a container

/v1.33
/v1.33
/v1.33
/v1.33
POST
/containers/create
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/v1.33/containers/create' \
--header 'Content-Type: application/json' \
--data-raw '{
    "AttachStderr": true,
    "AttachStdin": false,
    "AttachStdout": true,
    "Cmd": [
        "date"
    ],
    "Domainname": "",
    "Entrypoint": "",
    "Env": [
        "FOO=bar",
        "BAZ=quux"
    ],
    "ExposedPorts": {
        "22/tcp": {}
    },
    "HostConfig": {
        "AutoRemove": true,
        "Binds": [
            "/tmp:/tmp"
        ],
        "BlkioDeviceReadBps": [
            {}
        ],
        "BlkioDeviceReadIOps": [
            {}
        ],
        "BlkioDeviceWriteBps": [
            {}
        ],
        "BlkioDeviceWriteIOps": [
            {}
        ],
        "BlkioWeight": 300,
        "BlkioWeightDevice": [
            {}
        ],
        "CapAdd": [
            "NET_ADMIN"
        ],
        "CapDrop": [
            "MKNOD"
        ],
        "CgroupParent": "",
        "CpuPercent": 80,
        "CpuPeriod": 100000,
        "CpuQuota": 50000,
        "CpuRealtimePeriod": 1000000,
        "CpuRealtimeRuntime": 10000,
        "CpuShares": 512,
        "CpusetCpus": "0,1",
        "CpusetMems": "0,1",
        "Devices": [],
        "Dns": [
            "8.8.8.8"
        ],
        "DnsOptions": [
            ""
        ],
        "DnsSearch": [
            ""
        ],
        "GroupAdd": [
            "newgroup"
        ],
        "KernelMemory": 0,
        "Links": [
            "redis3:redis"
        ],
        "LogConfig": {
            "Config": {},
            "Type": "json-file"
        },
        "MaximumIOBps": 0,
        "MaximumIOps": 0,
        "Memory": 0,
        "MemoryReservation": 0,
        "MemorySwap": 0,
        "MemorySwappiness": 60,
        "NanoCPUs": 500000,
        "NetworkMode": "bridge",
        "OomKillDisable": false,
        "OomScoreAdj": 500,
        "PidMode": "",
        "PidsLimit": -1,
        "PortBindings": {
            "22/tcp": [
                {
                    "HostPort": "11022"
                }
            ]
        },
        "Privileged": false,
        "PublishAllPorts": false,
        "ReadonlyRootfs": false,
        "RestartPolicy": {
            "MaximumRetryCount": 0,
            "Name": ""
        },
        "SecurityOpt": [],
        "ShmSize": 67108864,
        "StorageOpt": {},
        "Ulimits": [
            {}
        ],
        "VolumeDriver": "",
        "VolumesFrom": [
            "parent",
            "other:ro"
        ]
    },
    "Hostname": "",
    "Image": "ubuntu",
    "Labels": {
        "com.example.license": "GPL",
        "com.example.vendor": "Acme",
        "com.example.version": "1.0"
    },
    "MacAddress": "12:34:56:78:9a:bc",
    "NetworkDisabled": false,
    "NetworkingConfig": {
        "EndpointsConfig": {
            "isolated_nw": {
                "Aliases": [
                    "server_x",
                    "server_y"
                ],
                "IPAMConfig": {
                    "IPv4Address": "172.20.30.33",
                    "IPv6Address": "2001:db8:abcd::3033",
                    "LinkLocalIPs": [
                        "169.254.34.68",
                        "fe80::3468"
                    ]
                },
                "Links": [
                    "container_1",
                    "container_2"
                ]
            }
        }
    },
    "OpenStdin": false,
    "StdinOnce": false,
    "StopSignal": "SIGTERM",
    "StopTimeout": 10,
    "Tty": false,
    "User": "",
    "Volumes": {
        "/volumes/data": {}
    },
    "WorkingDir": ""
}'
Response Response Example
201 - response
{
    "Id": "e90e34656806",
    "Warnings": []
}

Request

Query Params

Body Params application/json

Examples

Responses

🟢201Container created successfully
application/json
Body

🟠400bad parameter
🟠404no such container
🟠409conflict
🔴500server error
Modified at 2022-09-10 17:56:06
Previous
Update a Config
Next
List containers
Built with