title: “Engine API v1.20” description: “API Documentation for Docker” keywords: “API, Docker, rcli, REST, documentation” redirect_from:
unix:///var/run/docker.sock
but you can Bind Docker to another host/port or a Unix socket.attach
or pull
, the HTTP connection is hijacked to transport stdout
, stdin
and stderr
.Content-Length
header should be present in POST
requests to endpoints that expect a body./v1.18/info
. If no version is included in the URL, the maximum supported API version is used.400 Bad Request
error message is returned.GET /containers/json
List containers
Example request:
GET /v1.20/containers/json?all=1&before=8dfafdbc3a40&size=1 HTTP/1.1
Example response:
HTTP/1.1 200 OK Content-Type: application/json [ { "Id": "8dfafdbc3a40", "Names":["/boring_feynman"], "Image": "ubuntu:latest", "Command": "echo 1", "Created": 1367854155, "Status": "Exit 0", "Ports": [{"PrivatePort": 2222, "PublicPort": 3333, "Type": "tcp"}], "Labels": { "com.example.vendor": "Acme", "com.example.license": "GPL", "com.example.version": "1.0" }, "SizeRw": 12288, "SizeRootFs": 0 }, { "Id": "9cd87474be90", "Names":["/coolName"], "Image": "ubuntu:latest", "Command": "echo 222222", "Created": 1367854155, "Status": "Exit 0", "Ports": [], "Labels": {}, "SizeRw": 12288, "SizeRootFs": 0 }, { "Id": "3176a2479c92", "Names":["/sleepy_dog"], "Image": "ubuntu:latest", "Command": "echo 3333333333333333", "Created": 1367854154, "Status": "Exit 0", "Ports":[], "Labels": {}, "SizeRw":12288, "SizeRootFs":0 }, { "Id": "4cb07b47f9fb", "Names":["/running_cat"], "Image": "ubuntu:latest", "Command": "echo 444444444444444444444444444444444", "Created": 1367854152, "Status": "Exit 0", "Ports": [], "Labels": {}, "SizeRw": 12288, "SizeRootFs": 0 } ]
Query parameters:
limit
last created containers, include non-running ones.map[string][]string
) to process on the containers list. Available filters:exited=<int>
; -- containers with exit code of <int>
;status=
(created
|restarting
|running
|paused
|exited
)label=key
or label="key=value"
of a container labelStatus codes:
POST /containers/create
Create a container
Example request:
POST /v1.20/containers/create HTTP/1.1 Content-Type: application/json Content-Length: 12345 { "Hostname": "", "Domainname": "", "User": "", "AttachStdin": false, "AttachStdout": true, "AttachStderr": true, "Tty": false, "OpenStdin": false, "StdinOnce": false, "Env": [ "FOO=bar", "BAZ=quux" ], "Cmd": [ "date" ], "Entrypoint": null, "Image": "ubuntu", "Labels": { "com.example.vendor": "Acme", "com.example.license": "GPL", "com.example.version": "1.0" }, "Volumes": { "/volumes/data": {} }, "WorkingDir": "", "NetworkDisabled": false, "MacAddress": "12:34:56:78:9a:bc", "ExposedPorts": { "22/tcp": {} }, "HostConfig": { "Binds": ["/tmp:/tmp"], "Links": ["redis3:redis"], "LxcConf": {"lxc.utsname":"docker"}, "Memory": 0, "MemorySwap": 0, "CpuShares": 512, "CpuPeriod": 100000, "CpuQuota": 50000, "CpusetCpus": "0,1", "CpusetMems": "0,1", "BlkioWeight": 300, "MemorySwappiness": 60, "OomKillDisable": false, "PidMode": "", "PortBindings": { "22/tcp": [{ "HostPort": "11022" }] }, "PublishAllPorts": false, "Privileged": false, "ReadonlyRootfs": false, "Dns": ["8.8.8.8"], "DnsSearch": [""], "ExtraHosts": null, "VolumesFrom": ["parent", "other:ro"], "CapAdd": ["NET_ADMIN"], "CapDrop": ["MKNOD"], "GroupAdd": ["newgroup"], "RestartPolicy": { "Name": "", "MaximumRetryCount": 0 }, "NetworkMode": "bridge", "Devices": [], "Ulimits": [{}], "LogConfig": { "Type": "json-file", "Config": {} }, "SecurityOpt": [], "CgroupParent": "" } }
Example response:
HTTP/1.1 201 Created Content-Type: application/json { "Id":"e90e34656806", "Warnings":[] }
JSON parameters:
stdin
.stdout
.stderr
.tty
, including stdin
if it is not closed.stdin
,stdin
after the 1 attached client disconnects.["VAR=value", ...]
{"key":"value", ... }
"ExposedPorts": { "<port>/<tcp|udp>: {}" }
Binds – A list of bind mounts for this container. Each item is a string in one of these forms:
host-src:container-dest
to bind-mount a host path into the container. Both host-src
, and container-dest
must be an absolute path.host-src:container-dest:ro
to make the bind mount read-only inside the container. Both host-src
, and container-dest
must be an absolute path.Links - A list of links for the container. Each link entry should be in the form of container_name:alias
.
LxcConf - LXC specific configurations. These configurations only work when using the lxc
execution driver.
Memory - Memory limit in bytes.
MemorySwap - Total memory limit (memory + swap); set -1
to enable unlimited swap. You must use this with memory
and make the swap value larger than memory
.
CpuShares - An integer value containing the container's CPU Shares (ie. the relative weight vs other containers).
CpuPeriod - The length of a CPU period in microseconds.
CpuQuota - Microseconds of CPU time that the container can get in a CPU period.
CpusetCpus - String value containing the cgroups CpusetCpus
to use.
CpusetMems - Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only effective on NUMA systems.
BlkioWeight - Block IO weight (relative weight) accepts a weight value between 10 and 1000.
MemorySwappiness - Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100.
OomKillDisable - Boolean value, whether to disable OOM Killer for the container or not.
PidMode - Set the PID (Process) Namespace mode for the container; "container:<name|id>"
: joins another container‘s PID namespace "host"
: use the host’s PID namespace inside the container
PortBindings - A map of exposed container ports and the host port they should map to. A JSON object in the form { <port>/<protocol>: [{ "HostPort": "<port>" }] }
Take note that port
is specified as a string and not an integer value.
PublishAllPorts - Allocates an ephemeral host port for all of a container's exposed ports. Specified as a boolean value.
Ports are de-allocated when the container stops and allocated when the container starts. The allocated port might be changed when restarting the container.
The port is selected from the ephemeral port range that depends on the kernel. For example, on Linux the range is defined by /proc/sys/net/ipv4/ip_local_port_range
.
Privileged - Gives the container full access to the host. Specified as a boolean value.
ReadonlyRootfs - Mount the container's root filesystem as read only. Specified as a boolean value.
Dns - A list of DNS servers for the container to use.
DnsSearch - A list of DNS search domains
ExtraHosts - A list of hostnames/IP mappings to add to the container's /etc/hosts
file. Specified in the form ["hostname:IP"]
.
VolumesFrom - A list of volumes to inherit from another container. Specified in the form <container name>[:<ro|rw>]
CapAdd - A list of kernel capabilities to add to the container.
Capdrop - A list of kernel capabilities to drop from the container.
GroupAdd - A list of additional groups that the container process will run as
RestartPolicy – The behavior to apply when the container exits. The value is an object with a Name
property of either "always"
to always restart or "on-failure"
to restart only when the container exit code is non-zero. If on-failure
is used, MaximumRetryCount
controls the number of times to retry before giving up. The default is not to restart. (optional) An ever increasing delay (double the previous delay, starting at 100mS) is added before each restart to prevent flooding the server.
NetworkMode - Sets the networking mode for the container. Supported values are: bridge
, host
, none
, and container:<name|id>
Devices - A list of devices to add to the container specified as a JSON object in the form { "PathOnHost": "/dev/deviceName", "PathInContainer": "/dev/deviceName", "CgroupPermissions": "mrw"}
Ulimits - A list of ulimits to set in the container, specified as { "Name": <name>, "Soft": <soft limit>, "Hard": <hard limit> }
, for example: Ulimits: { "Name": "nofile", "Soft": 1024, "Hard": 2048 }
SecurityOpt: A list of string values to customize labels for MLS systems, such as SELinux.
LogConfig - Log configuration for the container, specified as a JSON object in the form { "Type": "<driver_name>", "Config": {"key1": "val1"}}
. Available types: json-file
, syslog
, journald
, gelf
, none
. json-file
logging driver.
CgroupParent - Path to cgroups
under which the container's cgroup
is created. If the path is not absolute, the path is considered to be relative to the cgroups
path of the init process. Cgroups are created if they do not already exist.
Query parameters:
/?[a-zA-Z0-9_-]+
.Status codes:
GET /containers/(id or name)/json
Return low-level information on the container id
Example request:
GET /v1.20/containers/4fa6e0f0c678/json HTTP/1.1
Example response:
HTTP/1.1 200 OK Content-Type: application/json { "AppArmorProfile": "", "Args": [ "-c", "exit 9" ], "Config": { "AttachStderr": true, "AttachStdin": false, "AttachStdout": true, "Cmd": [ "/bin/sh", "-c", "exit 9" ], "Domainname": "", "Entrypoint": null, "Env": [ "PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin" ], "ExposedPorts": null, "Hostname": "ba033ac44011", "Image": "ubuntu", "Labels": { "com.example.vendor": "Acme", "com.example.license": "GPL", "com.example.version": "1.0" }, "MacAddress": "", "NetworkDisabled": false, "OnBuild": null, "OpenStdin": false, "StdinOnce": false, "Tty": false, "User": "", "Volumes": null, "WorkingDir": "" }, "Created": "2015-01-06T15:47:31.485331387Z", "Driver": "devicemapper", "ExecDriver": "native-0.2", "ExecIDs": null, "HostConfig": { "Binds": null, "BlkioWeight": 0, "CapAdd": null, "CapDrop": null, "ContainerIDFile": "", "CpusetCpus": "", "CpusetMems": "", "CpuShares": 0, "CpuPeriod": 100000, "Devices": [], "Dns": null, "DnsSearch": null, "ExtraHosts": null, "IpcMode": "", "Links": null, "LxcConf": [], "Memory": 0, "MemorySwap": 0, "OomKillDisable": false, "NetworkMode": "bridge", "PidMode": "", "PortBindings": {}, "Privileged": false, "ReadonlyRootfs": false, "PublishAllPorts": false, "RestartPolicy": { "MaximumRetryCount": 2, "Name": "on-failure" }, "LogConfig": { "Config": null, "Type": "json-file" }, "SecurityOpt": null, "VolumesFrom": null, "Ulimits": [{}] }, "HostnamePath": "/var/lib/docker/containers/ba033ac4401106a3b513bc9d639eee123ad78ca3616b921167cd74b20e25ed39/hostname", "HostsPath": "/var/lib/docker/containers/ba033ac4401106a3b513bc9d639eee123ad78ca3616b921167cd74b20e25ed39/hosts", "LogPath": "/var/lib/docker/containers/1eb5fabf5a03807136561b3c00adcd2992b535d624d5e18b6cdc6a6844d9767b/1eb5fabf5a03807136561b3c00adcd2992b535d624d5e18b6cdc6a6844d9767b-json.log", "Id": "ba033ac4401106a3b513bc9d639eee123ad78ca3616b921167cd74b20e25ed39", "Image": "04c5d3b7b0656168630d3ba35d8889bd0e9caafcaeb3004d2bfbc47e7c5d35d2", "MountLabel": "", "Name": "/boring_euclid", "NetworkSettings": { "Bridge": "", "Gateway": "", "IPAddress": "", "IPPrefixLen": 0, "MacAddress": "", "PortMapping": null, "Ports": null }, "Path": "/bin/sh", "ProcessLabel": "", "ResolvConfPath": "/var/lib/docker/containers/ba033ac4401106a3b513bc9d639eee123ad78ca3616b921167cd74b20e25ed39/resolv.conf", "RestartCount": 1, "State": { "Error": "", "ExitCode": 9, "FinishedAt": "2015-01-06T15:47:32.080254511Z", "OOMKilled": false, "Paused": false, "Pid": 0, "Restarting": false, "Running": true, "StartedAt": "2015-01-06T15:47:32.072697474Z" }, "Mounts": [ { "Source": "/data", "Destination": "/data", "Mode": "ro,Z", "RW": false } ] }
Status codes:
GET /containers/(id or name)/top
List processes running inside the container id
. On Unix systems this is done by running the ps
command. This endpoint is not supported on Windows.
Example request:
GET /v1.20/containers/4fa6e0f0c678/top HTTP/1.1
Example response:
HTTP/1.1 200 OK Content-Type: application/json { "Titles" : [ "UID", "PID", "PPID", "C", "STIME", "TTY", "TIME", "CMD" ], "Processes" : [ [ "root", "13642", "882", "0", "17:03", "pts/0", "00:00:00", "/bin/bash" ], [ "root", "13735", "13642", "0", "17:06", "pts/0", "00:00:00", "sleep 10" ] ] }
Example request:
GET /v1.20/containers/4fa6e0f0c678/top?ps_args=aux HTTP/1.1
Example response:
HTTP/1.1 200 OK Content-Type: application/json { "Titles" : [ "USER","PID","%CPU","%MEM","VSZ","RSS","TTY","STAT","START","TIME","COMMAND" ] "Processes" : [ [ "root","13642","0.0","0.1","18172","3184","pts/0","Ss","17:03","0:00","/bin/bash" ], [ "root","13895","0.0","0.0","4348","692","pts/0","S+","17:15","0:00","sleep 10" ] ], }
Query parameters:
ps
arguments to use (e.g., aux
), defaults to -ef
Status codes:
GET /containers/(id or name)/logs
Get stdout
and stderr
logs from the container id
Note: This endpoint works only for containers with the
json-file
orjournald
logging drivers.
Example request:
GET /v1.20/containers/4fa6e0f0c678/logs?stderr=1&stdout=1×tamps=1&follow=1&tail=10&since=1428990821 HTTP/1.1
Example response:
HTTP/1.1 101 UPGRADED Content-Type: application/vnd.docker.raw-stream Connection: Upgrade Upgrade: tcp {% raw %} {{ STREAM }} {% endraw %}
Query parameters:
false
.stdout
log. Default false
.stderr
log. Default false
.false
.all
or <number>
. Default all.Status codes:
GET /containers/(id or name)/changes
Inspect changes on container id
's filesystem
Example request:
GET /v1.20/containers/4fa6e0f0c678/changes HTTP/1.1
Example response:
HTTP/1.1 200 OK Content-Type: application/json [ { "Path": "/dev", "Kind": 0 }, { "Path": "/dev/kmsg", "Kind": 1 }, { "Path": "/test", "Kind": 1 } ]
Values for Kind
:
0
: Modify1
: Add2
: DeleteStatus codes:
GET /containers/(id or name)/export
Export the contents of container id
Example request:
GET /v1.20/containers/4fa6e0f0c678/export HTTP/1.1
Example response:
HTTP/1.1 200 OK Content-Type: application/octet-stream {% raw %} {{ TAR STREAM }} {% endraw %}
Status codes:
GET /containers/(id or name)/stats
This endpoint returns a live stream of a container's resource usage statistics.
Example request:
GET /v1.20/containers/redis1/stats HTTP/1.1
Example response:
HTTP/1.1 200 OK Content-Type: application/json { "read" : "2015-01-08T22:57:31.547920715Z", "network" : { "rx_dropped" : 0, "rx_bytes" : 648, "rx_errors" : 0, "tx_packets" : 8, "tx_dropped" : 0, "rx_packets" : 8, "tx_errors" : 0, "tx_bytes" : 648 }, "memory_stats" : { "stats" : { "total_pgmajfault" : 0, "cache" : 0, "mapped_file" : 0, "total_inactive_file" : 0, "pgpgout" : 414, "rss" : 6537216, "total_mapped_file" : 0, "writeback" : 0, "unevictable" : 0, "pgpgin" : 477, "total_unevictable" : 0, "pgmajfault" : 0, "total_rss" : 6537216, "total_rss_huge" : 6291456, "total_writeback" : 0, "total_inactive_anon" : 0, "rss_huge" : 6291456, "hierarchical_memory_limit" : 67108864, "total_pgfault" : 964, "total_active_file" : 0, "active_anon" : 6537216, "total_active_anon" : 6537216, "total_pgpgout" : 414, "total_cache" : 0, "inactive_anon" : 0, "active_file" : 0, "pgfault" : 964, "inactive_file" : 0, "total_pgpgin" : 477 }, "max_usage" : 6651904, "usage" : 6537216, "failcnt" : 0, "limit" : 67108864 }, "blkio_stats" : {}, "cpu_stats" : { "cpu_usage" : { "percpu_usage" : [ 8646879, 24472255, 36438778, 30657443 ], "usage_in_usermode" : 50000000, "total_usage" : 100215355, "usage_in_kernelmode" : 30000000 }, "system_cpu_usage" : 739306590000000, "throttling_data" : {"periods":0,"throttled_periods":0,"throttled_time":0} }, "precpu_stats" : { "cpu_usage" : { "percpu_usage" : [ 8646879, 24350896, 36438778, 30657443 ], "usage_in_usermode" : 50000000, "total_usage" : 100093996, "usage_in_kernelmode" : 30000000 }, "system_cpu_usage" : 9492140000000, "throttling_data" : {"periods":0,"throttled_periods":0,"throttled_time":0} } }
The precpu_stats
is the cpu statistic of previous read, which is used for calculating the cpu usage percent. It is not the exact copy of the cpu_stats
field.
Query parameters:
true
.Status codes:
POST /containers/(id or name)/resize?h=<height>&w=<width>
Resize the TTY for container with id
. You must restart the container for the resize to take effect.
Example request:
POST /v1.20/containers/4fa6e0f0c678/resize?h=40&w=80 HTTP/1.1
Example response:
HTTP/1.1 200 OK Content-Length: 0 Content-Type: text/plain; charset=utf-8
Query parameters:
tty
sessionStatus codes:
POST /containers/(id or name)/start
Start the container id
Note: For backwards compatibility, this endpoint accepts a
HostConfig
as JSON-encoded request body. See create a container for details.
Example request:
POST /v1.20/containers/e90e34656806/start HTTP/1.1
Example response:
HTTP/1.1 204 No Content
Status codes:
POST /containers/(id or name)/stop
Stop the container id
Example request:
POST /v1.20/containers/e90e34656806/stop?t=5 HTTP/1.1
Example response:
HTTP/1.1 204 No Content
Query parameters:
Status codes:
POST /containers/(id or name)/restart
Restart the container id
Example request:
POST /v1.20/containers/e90e34656806/restart?t=5 HTTP/1.1
Example response:
HTTP/1.1 204 No Content
Query parameters:
Status codes:
POST /containers/(id or name)/kill
Kill the container id
Example request:
POST /v1.20/containers/e90e34656806/kill HTTP/1.1
Example response:
HTTP/1.1 204 No Content
Query parameters:
SIGINT
. When not set, SIGKILL
is assumed and the call waits for the container to exit.Status codes:
POST /containers/(id or name)/rename
Rename the container id
to a new_name
Example request:
POST /v1.20/containers/e90e34656806/rename?name=new_name HTTP/1.1
Example response:
HTTP/1.1 204 No Content
Query parameters:
Status codes:
POST /containers/(id or name)/pause
Pause the container id
Example request:
POST /v1.20/containers/e90e34656806/pause HTTP/1.1
Example response:
HTTP/1.1 204 No Content
Status codes:
POST /containers/(id or name)/unpause
Unpause the container id
Example request:
POST /v1.20/containers/e90e34656806/unpause HTTP/1.1
Example response:
HTTP/1.1 204 No Content
Status codes:
POST /containers/(id or name)/attach
Attach to the container id
Example request:
POST /v1.20/containers/16253994b7c4/attach?logs=1&stream=0&stdout=1 HTTP/1.1
Example response:
HTTP/1.1 101 UPGRADED Content-Type: application/vnd.docker.raw-stream Connection: Upgrade Upgrade: tcp {% raw %} {{ STREAM }} {% endraw %}
Query parameters:
false
.false
.stream=true
, attach to stdin
. Default false
.logs=true
, return stdout
log, if stream=true
, attach to stdout
. Default false
.logs=true
, return stderr
log, if stream=true
, attach to stderr
. Default false
.Status codes:
Stream details:
When using the TTY setting is enabled in POST /containers/create
, the stream is the raw data from the process PTY and client's stdin
. When the TTY is disabled, then the stream is multiplexed to separate stdout
and stderr
.
The format is a Header and a Payload (frame).
HEADER
The header contains the information which the stream writes (stdout
or stderr
). It also contains the size of the associated frame encoded in the last four bytes (uint32
).
It is encoded on the first eight bytes like this:
header := [8]byte{STREAM_TYPE, 0, 0, 0, SIZE1, SIZE2, SIZE3, SIZE4}
STREAM_TYPE
can be:
stdin
(is written on stdout
)stdout
stderr
SIZE1, SIZE2, SIZE3, SIZE4
are the four bytes of the uint32
size encoded as big endian.
PAYLOAD
The payload is the raw stream.
IMPLEMENTATION
The simplest way to implement the Attach protocol is the following:
1. Read eight bytes. 2. Choose `stdout` or `stderr` depending on the first byte. 3. Extract the frame size from the last four bytes. 4. Read the extracted size and output it on the correct output. 5. Goto 1.
GET /containers/(id or name)/attach/ws
Attach to the container id
via websocket
Implements websocket protocol handshake according to RFC 6455
Example request
GET /v1.20/containers/e90e34656806/attach/ws?logs=0&stream=1&stdin=1&stdout=1&stderr=1 HTTP/1.1
Example response
{% raw %} {{ STREAM }} {% endraw %}
Query parameters:
false
.false
.stream=true
, attach to stdin
. Default false
.logs=true
, return stdout
log, if stream=true
, attach to stdout
. Default false
.logs=true
, return stderr
log, if stream=true
, attach to stderr
. Default false
.Status codes:
POST /containers/(id or name)/wait
Block until container id
stops, then returns the exit code
Example request:
POST /v1.20/containers/16253994b7c4/wait HTTP/1.1
Example response:
HTTP/1.1 200 OK Content-Type: application/json {"StatusCode": 0}
Status codes:
DELETE /containers/(id or name)
Remove the container id
from the filesystem
Example request:
DELETE /v1.20/containers/16253994b7c4?v=1 HTTP/1.1
Example response:
HTTP/1.1 204 No Content
Query parameters:
false
.false
.false
.Status codes:
POST /containers/(id or name)/copy
Copy files or folders of container id
Deprecated in favor of the archive
endpoint below.
Example request:
POST /v1.20/containers/4fa6e0f0c678/copy HTTP/1.1 Content-Type: application/json Content-Length: 12345 { "Resource": "test.txt" }
Example response:
HTTP/1.1 200 OK Content-Type: application/x-tar {% raw %} {{ TAR STREAM }} {% endraw %}
Status codes:
HEAD /containers/(id or name)/archive
See the description of the X-Docker-Container-Path-Stat
header in the following section.
GET /containers/(id or name)/archive
Get a tar archive of a resource in the filesystem of container id
.
Query parameters:
path - resource in the container's filesystem to archive. Required.
If not an absolute path, it is relative to the container's root directory. The resource specified by path must exist. To assert that the resource is expected to be a directory, path should end in /
or /.
(assuming a path separator of /
). If path ends in /.
then this indicates that only the contents of the path directory should be copied. A symlink is always resolved to its target.
Note: It is not possible to copy certain system files such as resources under
/proc
,/sys
,/dev
, and mounts created by the user in the container.
Example request:
GET /v1.20/containers/8cce319429b2/archive?path=/root HTTP/1.1
Example response:
HTTP/1.1 200 OK Content-Type: application/x-tar X-Docker-Container-Path-Stat: eyJuYW1lIjoicm9vdCIsInNpemUiOjQwOTYsIm1vZGUiOjIxNDc0ODQwOTYsIm10aW1lIjoiMjAxNC0wMi0yN1QyMDo1MToyM1oiLCJsaW5rVGFyZ2V0IjoiIn0= {% raw %} {{ TAR STREAM }} {% endraw %}
On success, a response header X-Docker-Container-Path-Stat
will be set to a base64-encoded JSON object containing some filesystem header information about the archived resource. The above example value would decode to the following JSON object (whitespace added for readability):
{ "name": "root", "size": 4096, "mode": 2147484096, "mtime": "2014-02-27T20:51:23Z", "linkTarget": "" }
A HEAD
request can also be made to this endpoint if only this information is desired.
Status codes:
id
does not exist)PUT /containers/(id or name)/archive
Upload a tar archive to be extracted to a path in the filesystem of container id
.
Query parameters:
path - path to a directory in the container to extract the archive's contents into. Required.
If not an absolute path, it is relative to the container's root directory. The path resource must exist.
noOverwriteDirNonDir - If “1”, “true”, or “True” then it will be an error if unpacking the given content would cause an existing directory to be replaced with a non-directory and vice versa.
Example request:
PUT /v1.20/containers/8cce319429b2/archive?path=/vol1 HTTP/1.1 Content-Type: application/x-tar {% raw %} {{ TAR STREAM }} {% endraw %}
Example response:
HTTP/1.1 200 OK
Status codes:
id
does not exist)GET /images/json
Example request:
GET /v1.20/images/json?all=0 HTTP/1.1
Example response:
HTTP/1.1 200 OK Content-Type: application/json [ { "RepoTags": [ "ubuntu:12.04", "ubuntu:precise", "ubuntu:latest" ], "Id": "8dbd9e392a964056420e5d58ca5cc376ef18e2de93b5cc90e868a1bbc8318c1c", "Created": 1365714795, "Size": 131506275, "VirtualSize": 131506275, "Labels": {} }, { "RepoTags": [ "ubuntu:12.10", "ubuntu:quantal" ], "ParentId": "27cf784147099545", "Id": "b750fe79269d2ec9a3c593ef05b4332b1d1a02a62b4accb2c21d589ff2f5f2dc", "Created": 1364102658, "Size": 24653, "VirtualSize": 180116135, "Labels": { "com.example.version": "v1" } } ]
Example request, with digest information:
GET /v1.20/images/json?digests=1 HTTP/1.1
Example response, with digest information:
HTTP/1.1 200 OK Content-Type: application/json [ { "Created": 1420064636, "Id": "4986bf8c15363d1c5d15512d5266f8777bfba4974ac56e3270e7760f6f0a8125", "ParentId": "ea13149945cb6b1e746bf28032f02e9b5a793523481a0a18645fc77ad53c4ea2", "RepoDigests": [ "localhost:5000/test/busybox@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf" ], "RepoTags": [ "localhost:5000/test/busybox:latest", "playdate:latest" ], "Size": 0, "VirtualSize": 2429728, "Labels": {} } ]
The response shows a single image Id
associated with two repositories (RepoTags
): localhost:5000/test/busybox
: and playdate
. A caller can use either of the RepoTags
values localhost:5000/test/busybox:latest
or playdate:latest
to reference the image.
You can also use RepoDigests
values to reference an image. In this response, the array has only one reference and that is to the localhost:5000/test/busybox
repository; the playdate
repository has no digest. You can reference this digest using the value: localhost:5000/test/busybox@sha256:cbbf2f9a99b47fc460d...
See the docker run
and docker build
commands for examples of digest and tag references on the command line.
Query parameters:
dangling=true
label=key
or label="key=value"
of an image labelPOST /build
Build an image from a Dockerfile
Example request:
POST /v1.20/build HTTP/1.1 Content-Type: application/x-tar {% raw %} {{ TAR STREAM }} {% endraw %}
Example response:
HTTP/1.1 200 OK Content-Type: application/json {"stream": "Step 1/5..."} {"stream": "..."} {"error": "Error...", "errorDetail": {"code": 123, "message": "Error..."}}
The input stream must be a tar
archive compressed with one of the following algorithms: identity
(no compression), gzip
, bzip2
, xz
.
The archive must include a build instructions file, typically called Dockerfile
at the archive's root. The dockerfile
parameter may be used to specify a different build instructions file. To do this, its value must be the path to the alternate build instructions file to use.
The archive may include any number of other files, which are accessible in the build context (See the ADD build command).
The Docker daemon performs a preliminary validation of the Dockerfile
before starting the build, and returns an error if the syntax is incorrect. After that, each instruction is run one-by-one until the ID of the new image is output.
The build is canceled if the client drops the connection by quitting or being killed.
Query parameters:
Dockerfile
. This is ignored if remote
is specified and points to an external Dockerfile
.name:tag
format. If you omit the tag
the default latest
value is assumed.Dockerfile
and the image is built from that file. If the URI points to a tarball, the file is downloaded by the daemon and the contents therein used as the context for the build. If the URI points to a tarball and the dockerfile
parameter is also specified, there must be a file with the corresponding path inside the tarball.rm
).-1
to enable unlimited swap.0-3
, 0,1
).Request Headers:
Content-type – Set to "application/x-tar"
.
X-Registry-Config – A base64-url-safe-encoded Registry Auth Config JSON object with the following structure:
{ "docker.example.com": { "username": "janedoe", "password": "hunter2" }, "https://index.docker.io/v1/": { "username": "mobydock", "password": "conta1n3rize14" } }
This object maps the hostname of a registry to an object containing the “username” and “password” for that registry. Multiple registries may be specified as the build may be based on an image requiring authentication to pull from any arbitrary registry. Only the registry domain name (and port if not the default “443”) are required. However (for legacy reasons) the “official” Docker, Inc. hosted registry must be specified with both a “https://” prefix and a “/v1/” suffix even though Docker will prefer to use the v2 registry API.
Status codes:
POST /images/create
Create an image either by pulling it from the registry or by importing it
Example request:
POST /v1.20/images/create?fromImage=busybox&tag=latest HTTP/1.1
Example response:
HTTP/1.1 200 OK Content-Type: application/json {"status": "Pulling..."} {"status": "Pulling", "progress": "1 B/ 100 B", "progressDetail": {"current": 1, "total": 100}} {"error": "Invalid..."} ...
When using this endpoint to pull an image from the registry, the X-Registry-Auth
header can be used to include a base64-encoded AuthConfig object.
Query parameters:
-
to read the image from the request body.Request Headers:
Status codes:
GET /images/(name)/json
Return low-level information on the image name
Example request:
GET /v1.20/images/ubuntu/json HTTP/1.1
Example response:
HTTP/1.1 200 OK Content-Type: application/json { "Created": "2013-03-23T22:24:18.818426-07:00", "Container": "3d67245a8d72ecf13f33dffac9f79dcdf70f75acb84d308770391510e0c23ad0", "ContainerConfig": { "Hostname": "", "User": "", "AttachStdin": false, "AttachStdout": false, "AttachStderr": false, "Tty": true, "OpenStdin": true, "StdinOnce": false, "Env": null, "Cmd": ["/bin/bash"], "Dns": null, "Image": "ubuntu", "Labels": { "com.example.vendor": "Acme", "com.example.license": "GPL", "com.example.version": "1.0" }, "Volumes": null, "VolumesFrom": "", "WorkingDir": "" }, "Id": "b750fe79269d2ec9a3c593ef05b4332b1d1a02a62b4accb2c21d589ff2f5f2dc", "Parent": "27cf784147099545", "Size": 6824592 }
Status codes:
GET /images/(name)/history
Return the history of the image name
Example request:
GET /v1.20/images/ubuntu/history HTTP/1.1
Example response:
HTTP/1.1 200 OK Content-Type: application/json [ { "Id": "3db9c44f45209632d6050b35958829c3a2aa256d81b9a7be45b362ff85c54710", "Created": 1398108230, "CreatedBy": "/bin/sh -c #(nop) ADD file:eb15dbd63394e063b805a3c32ca7bf0266ef64676d5a6fab4801f2e81e2a5148 in /", "Tags": [ "ubuntu:lucid", "ubuntu:10.04" ], "Size": 182964289, "Comment": "" }, { "Id": "6cfa4d1f33fb861d4d114f43b25abd0ac737509268065cdfd69d544a59c85ab8", "Created": 1398108222, "CreatedBy": "/bin/sh -c #(nop) MAINTAINER Tianon Gravi <admwiggin@gmail.com> - mkimage-debootstrap.sh -i iproute,iputils-ping,ubuntu-minimal -t lucid.tar.xz lucid http://archive.ubuntu.com/ubuntu/", "Tags": null, "Size": 0, "Comment": "" }, { "Id": "511136ea3c5a64f264b78b5433614aec563103b4d4702f3ba7d4d2698e22c158", "Created": 1371157430, "CreatedBy": "", "Tags": [ "scratch12:latest", "scratch:latest" ], "Size": 0, "Comment": "Imported from -" } ]
Status codes:
POST /images/(name)/push
Push the image name
on the registry
Example request:
POST /v1.20/images/test/push HTTP/1.1
Example response:
HTTP/1.1 200 OK Content-Type: application/json {"status": "Pushing..."} {"status": "Pushing", "progress": "1/? (n/a)", "progressDetail": {"current": 1}}} {"error": "Invalid..."} ...
If you wish to push an image on to a private registry, that image must already have a tag into a repository which references that registry hostname
and port
. This repository name should then be used in the URL. This duplicates the command line's flow.
Example request:
POST /v1.20/images/registry.acme.com:5000/test/push HTTP/1.1
Query parameters:
Request Headers:
Status codes:
POST /images/(name)/tag
Tag the image name
into a repository
Example request:
POST /v1.20/images/test/tag?repo=myrepo&force=0&tag=v42 HTTP/1.1
Example response:
HTTP/1.1 201 Created
Query parameters:
Status codes:
DELETE /images/(name)
Remove the image name
from the filesystem
Example request:
DELETE /v1.20/images/test HTTP/1.1
Example response:
HTTP/1.1 200 OK Content-type: application/json [ {"Untagged": "3e2f21a89f"}, {"Deleted": "3e2f21a89f"}, {"Deleted": "53b4f83ac9"} ]
Query parameters:
Status codes:
GET /images/search
Search for an image on Docker Hub.
Note: The response keys have changed from API v1.6 to reflect the JSON sent by the registry server to the docker daemon's request.
Example request:
GET /v1.20/images/search?term=sshd HTTP/1.1
Example response:
HTTP/1.1 200 OK Content-Type: application/json [ { "description": "", "is_official": false, "is_automated": false, "name": "wma55/u1210sshd", "star_count": 0 }, { "description": "", "is_official": false, "is_automated": false, "name": "jdswinbank/sshd", "star_count": 0 }, { "description": "", "is_official": false, "is_automated": false, "name": "vgauthier/sshd", "star_count": 0 } ... ]
Query parameters:
Status codes:
POST /auth
Get the default username and email
Example request:
POST /v1.20/auth HTTP/1.1 Content-Type: application/json Content-Length: 12345 { "username": "hannibal", "password": "xxxx", "email": "hannibal@a-team.com", "serveraddress": "https://index.docker.io/v1/" }
Example response:
HTTP/1.1 200 OK
Status codes:
GET /info
Display system-wide information
Example request:
GET /v1.20/info HTTP/1.1
Example response:
HTTP/1.1 200 OK Content-Type: application/json { "Containers": 11, "CpuCfsPeriod": true, "CpuCfsQuota": true, "Debug": false, "DockerRootDir": "/var/lib/docker", "Driver": "btrfs", "DriverStatus": [[""]], "ExecutionDriver": "native-0.1", "ExperimentalBuild": false, "HttpProxy": "http://test:test@localhost:8080", "HttpsProxy": "https://test:test@localhost:8080", "ID": "7TRN:IPZB:QYBB:VPBQ:UMPP:KARE:6ZNR:XE6T:7EWV:PKF4:ZOJD:TPYS", "IPv4Forwarding": true, "Images": 16, "IndexServerAddress": "https://index.docker.io/v1/", "InitPath": "/usr/bin/docker", "InitSha1": "", "KernelVersion": "3.12.0-1-amd64", "Labels": [ "storage=ssd" ], "MemTotal": 2099236864, "MemoryLimit": true, "NCPU": 1, "NEventsListener": 0, "NFd": 11, "NGoroutines": 21, "Name": "prod-server-42", "NoProxy": "9.81.1.160", "OomKillDisable": true, "OperatingSystem": "Boot2Docker", "RegistryConfig": { "IndexConfigs": { "docker.io": { "Mirrors": null, "Name": "docker.io", "Official": true, "Secure": true } }, "InsecureRegistryCIDRs": [ "127.0.0.0/8" ] }, "SwapLimit": false, "SystemTime": "2015-03-10T11:11:23.730591467-07:00" }
Status codes:
GET /version
Show the docker version information
Example request:
GET /v1.20/version HTTP/1.1
Example response:
HTTP/1.1 200 OK Content-Type: application/json { "Version": "1.5.0", "Os": "linux", "KernelVersion": "3.18.5-tinycore64", "GoVersion": "go1.4.1", "GitCommit": "a8a31ef", "Arch": "amd64", "ApiVersion": "1.20", "Experimental": false }
Status codes:
GET /_ping
Ping the docker server
Example request:
GET /v1.20/_ping HTTP/1.1
Example response:
HTTP/1.1 200 OK Content-Type: text/plain OK
Status codes:
POST /commit
Create a new image from a container's changes
Example request:
POST /v1.20/commit?container=44c004db4b17&comment=message&repo=myrepo HTTP/1.1 Content-Type: application/json Content-Length: 12345 { "Hostname": "", "Domainname": "", "User": "", "AttachStdin": false, "AttachStdout": true, "AttachStderr": true, "Tty": false, "OpenStdin": false, "StdinOnce": false, "Env": null, "Cmd": [ "date" ], "Mounts": [ { "Source": "/data", "Destination": "/data", "Mode": "ro,Z", "RW": false } ], "Labels": { "key1": "value1", "key2": "value2" }, "WorkingDir": "", "NetworkDisabled": false, "ExposedPorts": { "22/tcp": {} } }
Example response:
HTTP/1.1 201 Created Content-Type: application/json {"Id": "596069db4bf5"}
JSON parameters:
Query parameters:
Status codes:
GET /events
Get container events from docker, in real time via streaming.
Docker containers report the following events:
attach, commit, copy, create, destroy, die, exec_create, exec_start, export, kill, oom, pause, rename, resize, restart, start, stop, top, unpause
Docker images report the following events:
delete, import, pull, push, tag, untag
Example request:
GET /v1.20/events?since=1374067924
Example response:
HTTP/1.1 200 OK Content-Type: application/json {"status": "create", "id": "dfdf82bd3881","from": "ubuntu:latest", "time":1374067924} {"status": "start", "id": "dfdf82bd3881","from": "ubuntu:latest", "time":1374067924} {"status": "stop", "id": "dfdf82bd3881","from": "ubuntu:latest", "time":1374067966} {"status": "destroy", "id": "dfdf82bd3881","from": "ubuntu:latest", "time":1374067970}
Query parameters:
container=<string>
; -- container to filterevent=<string>
; -- event to filterimage=<string>
; -- image to filterStatus codes:
GET /images/(name)/get
Get a tarball containing all images and metadata for the repository specified by name
.
If name
is a specific name and tag (e.g. ubuntu:latest), then only that image (and its parents) are returned. If name
is an image ID, similarly only that image (and its parents) are returned, but with the exclusion of the ‘repositories’ file in the tarball, as there were no image names referenced.
See the image tarball format for more details.
Example request
GET /v1.20/images/ubuntu/get
Example response:
HTTP/1.1 200 OK Content-Type: application/x-tar Binary data stream
Status codes:
GET /images/get
Get a tarball containing all images and metadata for one or more repositories.
For each value of the names
parameter: if it is a specific name and tag (e.g. ubuntu:latest
), then only that image (and its parents) are returned; if it is an image ID, similarly only that image (and its parents) are returned and there would be no names referenced in the ‘repositories’ file for this image ID.
See the image tarball format for more details.
Example request
GET /v1.20/images/get?names=myname%2Fmyapp%3Alatest&names=busybox
Example response:
HTTP/1.1 200 OK Content-Type: application/x-tar Binary data stream
Status codes:
POST /images/load
Load a set of images and tags into a Docker repository. See the image tarball format for more details.
Example request
POST /v1.20/images/load Content-Type: application/x-tar Content-Length: 12345 Tarball in body
Example response:
HTTP/1.1 200 OK
Status codes:
An image tarball contains one directory per image layer (named using its long ID), each containing these files:
VERSION
: currently 1.0
- the file format versionjson
: detailed layer information, similar to docker inspect layer_id
layer.tar
: A tarfile containing the filesystem changes in this layerThe layer.tar
file contains aufs
style .wh..wh.aufs
files and directories for storing attribute changes and deletions.
If the tarball defines a repository, the tarball should also include a repositories
file at the root that contains a list of repository and tag names mapped to layer IDs.
{"hello-world": {"latest": "565a9d68a73f6706862bfe8409a7f659776d4d60a8d096eb4a3cbce6999cc2a1"} }
POST /containers/(id or name)/exec
Sets up an exec instance in a running container id
Example request:
POST /v1.20/containers/e90e34656806/exec HTTP/1.1 Content-Type: application/json Content-Length: 12345 { "AttachStdin": true, "AttachStdout": true, "AttachStderr": true, "Cmd": ["sh"], "Tty": true, "User": "123:456" }
Example response:
HTTP/1.1 201 Created Content-Type: application/json { "Id": "f90e34656806", "Warnings":[] }
JSON parameters:
stdin
of the exec
command.stdout
of the exec
command.stderr
of the exec
command."user"
, "user:group"
, "uid"
, or "uid:gid"
.Status codes:
POST /exec/(id)/start
Starts a previously set up exec
instance id
. If detach
is true, this API returns after starting the exec
command. Otherwise, this API sets up an interactive session with the exec
command.
Example request:
POST /v1.20/exec/e90e34656806/start HTTP/1.1 Content-Type: application/json Content-Length: 12345 { "Detach": false, "Tty": false }
Example response:
HTTP/1.1 200 OK Content-Type: application/vnd.docker.raw-stream {% raw %} {{ STREAM }} {% endraw %}
JSON parameters:
exec
command.Status codes:
Stream details:
Similar to the stream behavior of POST /containers/(id or name)/attach
API
POST /exec/(id)/resize
Resizes the tty
session used by the exec
command id
. The unit is number of characters. This API is valid only if tty
was specified as part of creating and starting the exec
command.
Example request:
POST /v1.20/exec/e90e34656806/resize?h=40&w=80 HTTP/1.1 Content-Type: text/plain
Example response:
HTTP/1.1 201 Created Content-Type: text/plain
Query parameters:
tty
sessionStatus codes:
GET /exec/(id)/json
Return low-level information about the exec
command id
.
Example request:
GET /v1.20/exec/11fb006128e8ceb3942e7c58d77750f24210e35f879dd204ac975c184b820b39/json HTTP/1.1
Example response:
HTTP/1.1 200 OK Content-Type: plain/text { "ID" : "11fb006128e8ceb3942e7c58d77750f24210e35f879dd204ac975c184b820b39", "Running" : false, "ExitCode" : 2, "ProcessConfig" : { "privileged" : false, "user" : "", "tty" : false, "entrypoint" : "sh", "arguments" : [ "-c", "exit 2" ] }, "OpenStdin" : false, "OpenStderr" : false, "OpenStdout" : false, "Container" : { "State" : { "Running" : true, "Paused" : false, "Restarting" : false, "OOMKilled" : false, "Pid" : 3650, "ExitCode" : 0, "Error" : "", "StartedAt" : "2014-11-17T22:26:03.717657531Z", "FinishedAt" : "0001-01-01T00:00:00Z" }, "ID" : "8f177a186b977fb451136e0fdf182abff5599a08b3c7f6ef0d36a55aaf89634c", "Created" : "2014-11-17T22:26:03.626304998Z", "Path" : "date", "Args" : [], "Config" : { "Hostname" : "8f177a186b97", "Domainname" : "", "User" : "", "AttachStdin" : false, "AttachStdout" : false, "AttachStderr" : false, "ExposedPorts" : null, "Tty" : false, "OpenStdin" : false, "StdinOnce" : false, "Env" : [ "PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin" ], "Cmd" : [ "date" ], "Image" : "ubuntu", "Volumes" : null, "WorkingDir" : "", "Entrypoint" : null, "NetworkDisabled" : false, "MacAddress" : "", "OnBuild" : null, "SecurityOpt" : null }, "Image" : "5506de2b643be1e6febbf3b8a240760c6843244c41e12aa2f60ccbb7153d17f5", "NetworkSettings" : { "IPAddress" : "172.17.0.2", "IPPrefixLen" : 16, "MacAddress" : "02:42:ac:11:00:02", "Gateway" : "172.17.42.1", "Bridge" : "docker0", "PortMapping" : null, "Ports" : {} }, "ResolvConfPath" : "/var/lib/docker/containers/8f177a186b977fb451136e0fdf182abff5599a08b3c7f6ef0d36a55aaf89634c/resolv.conf", "HostnamePath" : "/var/lib/docker/containers/8f177a186b977fb451136e0fdf182abff5599a08b3c7f6ef0d36a55aaf89634c/hostname", "HostsPath" : "/var/lib/docker/containers/8f177a186b977fb451136e0fdf182abff5599a08b3c7f6ef0d36a55aaf89634c/hosts", "LogPath": "/var/lib/docker/containers/1eb5fabf5a03807136561b3c00adcd2992b535d624d5e18b6cdc6a6844d9767b/1eb5fabf5a03807136561b3c00adcd2992b535d624d5e18b6cdc6a6844d9767b-json.log", "Name" : "/test", "Driver" : "aufs", "ExecDriver" : "native-0.2", "MountLabel" : "", "ProcessLabel" : "", "AppArmorProfile" : "", "RestartCount" : 0, "Mounts" : [] } }
Status codes:
docker run
As an example, the docker run
command line makes the following API calls:
Create the container
If the status code is 404, it means the image doesn't exist:
Start the container.
If you are not in detached mode:
Attach to the container, using logs=1
(to have stdout
and stderr
from the container's start) and stream=1
If in detached mode or only stdin
is attached, display the container's id.
In this version of the API, /attach
, uses hijacking to transport stdin
, stdout
, and stderr
on the same socket.
To hint potential proxies about connection hijacking, Docker client sends connection upgrade headers similarly to websocket.
Upgrade: tcp Connection: Upgrade
When Docker daemon detects the Upgrade
header, it switches its status code from 200 OK to 101 UPGRADED and resends the same headers.
To set cross origin requests to the Engine API please give values to --api-cors-header
when running Docker in daemon mode. Set * (asterisk) allows all, default or blank means CORS disabled
$ dockerd -H="192.168.1.9:2375" --api-cors-header="http://foo.bar"