rcli
.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
.400 Bad Request
error message.GET /containers/json
List containers
Example request:
GET /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=
(restarting
|running
|paused
|exited
)label=key
or label="key=value"
of a container labelStatus Codes:
POST /containers/create
Create a container
Example request:
POST /containers/create HTTP/1.1 Content-Type: application/json { "Hostname": "", "Domainname": "", "User": "", "AttachStdin": false, "AttachStdout": true, "AttachStderr": true, "Tty": false, "OpenStdin": false, "StdinOnce": false, "Env": [ "FOO=bar", "BAZ=quux" ], "Cmd": [ "date" ], "Entrypoint": "", "Image": "ubuntu", "Labels": { "com.example.vendor": "Acme", "com.example.license": "GPL", "com.example.version": "1.0" }, "Volumes": { "/tmp": {} }, "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, "OomKillDisable": false, "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"], "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:
-1
to enable unlimited swap. You must use this with memory
and make the swap value larger than memory
.CpusetCpus
instead.cgroups CpusetCpus
to use.stdin
.stdout
.stderr
.tty
, including stdin
if it is not closed.stdin
after the 1 attached client disconnects.["VAR=value"[,"VAR2=value2"]]
{"key":"value"[,"key2":"value2"]}
"ExposedPorts": { "<port>/<tcp|udp>: {}" }
container_path
to create a new volume for the containerhost_path:container_path
to bind-mount a host path into the containerhost_path:container_path:ro
to make the bind-mount read-only inside the container.container_name:alias
.lxc
execution driver.{ <port>/<protocol>: [{ "HostPort": "<port>" }] }
Take note that port
is specified as a string and not an integer value./etc/hosts
file. Specified in the form ["hostname:IP"]
.<container name>[:<ro|rw>]
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.bridge
, host
, and container:<name|id>
{ "PathOnHost": "/dev/deviceName", "PathInContainer": "/dev/deviceName", "CgroupPermissions": "mrw"}
{ "Name": <name>, "Soft": <soft limit>, "Hard": <hard limit> }
, for example: Ulimits: { "Name": "nofile", "Soft": 1024, "Hard": 2048 }
{ "Type": "<driver_name>", "Config": {"key1": "val1"}}
. Available types: json-file
, syslog
, journald
, none
. syslog
available options are: address
.Query Parameters:
/?[a-zA-Z0-9_-]+
.Status Codes:
GET /containers/(id)/json
Return low-level information on the container id
Example request:
GET /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, "PortSpecs": null, "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", "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": false, "StartedAt": "2015-01-06T15:47:32.072697474Z" }, "Volumes": {}, "VolumesRW": {} }
Status Codes:
GET /containers/(id)/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 /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 /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)/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 /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 {{ STREAM }}
Query Parameters:
false
.stdout
log. Default false
.stderr
log. Default false
.false
.all
or <number>
. Default all.Status Codes:
GET /containers/(id)/changes
Inspect changes on container id
's filesystem
Example request:
GET /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)/export
Export the contents of container id
Example request:
GET /containers/4fa6e0f0c678/export HTTP/1.1
Example response:
HTTP/1.1 200 OK Content-Type: application/octet-stream {{ TAR STREAM }}
Status Codes:
GET /containers/(id)/stats
This endpoint returns a live stream of a container's resource usage statistics.
Example request:
GET /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" : [ 16970827, 1839451, 7107380, 10571290 ], "usage_in_usermode" : 10000000, "total_usage" : 36488948, "usage_in_kernelmode" : 20000000 }, "system_cpu_usage" : 20091722000000000, "throttling_data" : {} } }
Query Parameters:
true
.Status Codes:
POST /containers/(id)/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 /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
Status Codes:
POST /containers/(id)/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 /containers/(id)/start HTTP/1.1
Example response:
HTTP/1.1 204 No Content
Status Codes:
POST /containers/(id)/stop
Stop the container id
Example request:
POST /containers/e90e34656806/stop?t=5 HTTP/1.1
Example response:
HTTP/1.1 204 No Content
Query Parameters:
Status Codes:
POST /containers/(id)/restart
Restart the container id
Example request:
POST /containers/e90e34656806/restart?t=5 HTTP/1.1
Example response:
HTTP/1.1 204 No Content
Query Parameters:
Status Codes:
POST /containers/(id)/kill
Kill the container id
Example request:
POST /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)/rename
Rename the container id
to a new_name
Example request:
POST /containers/e90e34656806/rename?name=new_name HTTP/1.1
Example response:
HTTP/1.1 204 No Content
Query Parameters:
Status Codes:
POST /containers/(id)/pause
Pause the container id
Example request:
POST /containers/e90e34656806/pause HTTP/1.1
Example response:
HTTP/1.1 204 No Content
Status Codes:
POST /containers/(id)/unpause
Unpause the container id
Example request:
POST /containers/e90e34656806/unpause HTTP/1.1
Example response:
HTTP/1.1 204 No Content
Status Codes:
POST /containers/(id)/attach
Attach to the container id
Example request:
POST /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 {{ STREAM }}
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:
101 – no error, hints proxy about hijacking
200 – no error, no upgrade header found
400 – bad parameter
404 – no such container
500 – server error
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:
0: stdin
(is written on stdout
)
1: stdout
2: 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:
stdout
or stderr
depending on the first byte.GET /containers/(id)/attach/ws
Attach to the container id
via websocket
Implements websocket protocol handshake according to RFC 6455
Example request
GET /containers/e90e34656806/attach/ws?logs=0&stream=1&stdin=1&stdout=1&stderr=1 HTTP/1.1
Example response
{{ STREAM }}
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)/wait
Block until container id
stops, then returns the exit code
Example request:
POST /containers/16253994b7c4/wait HTTP/1.1
Example response:
HTTP/1.1 200 OK Content-Type: application/json {"StatusCode": 0}
Status Codes:
DELETE /containers/(id)
Remove the container id
from the filesystem
Example request:
DELETE /containers/16253994b7c4?v=1 HTTP/1.1
Example response:
HTTP/1.1 204 No Content
Query Parameters:
false
.false
.Status Codes:
POST /containers/(id)/copy
Copy files or folders of container id
Example request:
POST /containers/4fa6e0f0c678/copy HTTP/1.1 Content-Type: application/json { "Resource": "test.txt" }
Example response:
HTTP/1.1 200 OK Content-Type: application/x-tar {{ TAR STREAM }}
Status Codes:
GET /images/json
Example request:
GET /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 /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 /build HTTP/1.1 {{ TAR STREAM }}
Example response:
HTTP/1.1 200 OK Content-Type: application/json {"stream": "Step 1..."} {"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 build is canceled if the client drops the connection by quitting or being killed.
Query Parameters:
dockerfile - Path within the build context to the Dockerfile
. This is ignored if remote
is specified and points to an external Dockerfile
.
t – Repository name (and optionally a tag) to be applied to the resulting image in case of success.
remote – A Git repository URI or HTTP/HTTPS context URI. If the URI points to a single text file, the file's contents are placed into a file called 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.
q – Suppress verbose build output.
nocache – Do not use the cache when building the image.
pull - Attempt to pull the image even if an older image exists locally.
rm - Remove intermediate containers after a successful build (default behavior).
forcerm - Always remove intermediate containers (includes rm
).
memory - Set memory limit for build.
memswap - Total memory (memory + swap), -1
to enable unlimited swap.
cpushares - CPU shares (relative weight).
cpusetcpus - CPUs in which to allow execution (e.g., 0-3
, 0,1
).
cpuperiod - The length of a CPU period in microseconds.
cpuquota - Microseconds of CPU time that the container can get in a CPU period.
Request Headers:
Content-type – Set to "application/tar"
.
X-Registry-Config – base64-encoded ConfigFile object
Status Codes:
POST /images/create
Create an image either by pulling it from the registry or by importing it
Example request:
POST /images/create?fromImage=ubuntu 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:
fromImage – Name of the image to pull.
fromSrc – Source to import. The value may be a URL from which the image can be retrieved or -
to read the image from the request body.
repo – Repository name.
tag – Tag.
registry – The registry to pull from.
Request Headers:
X-Registry-Auth – base64-encoded AuthConfig object
Status Codes:
GET /images/(name)/json
Return low-level information on the image name
Example request:
GET /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, "PortSpecs": null, "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 /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 /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 /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 /images/test/tag?repo=myrepo&force=0&tag=v42 HTTP/1.1
Example response:
HTTP/1.1 201 OK
Query Parameters:
Status Codes:
DELETE /images/(name)
Remove the image name
from the filesystem
Example request:
DELETE /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. This API returns both is_trusted
and is_automated
images. Currently, they are considered identical. In the future, the is_trusted
property will be deprecated and replaced by the is_automated
property.
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 /images/search?term=sshd HTTP/1.1
Example response:
HTTP/1.1 200 OK Content-Type: application/json [ { "star_count": 12, "is_official": false, "name": "wma55/u1210sshd", "is_trusted": false, "is_automated": false, "description": "", }, { "star_count": 10, "is_official": false, "name": "jdswinbank/sshd", "is_trusted": false, "is_automated": false, "description": "", }, { "star_count": 18, "is_official": false, "name": "vgauthier/sshd", "is_trusted": false, "is_automated": false, "description": "", } ... ]
Query Parameters:
Status Codes:
POST /auth
Get the default username and email
Example request:
POST /auth HTTP/1.1 Content-Type: application/json { "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 /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 /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.19" }
Status Codes:
GET /_ping
Ping the docker server
Example request:
GET /_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 /commit?container=44c004db4b17&comment=message&repo=myrepo HTTP/1.1 Content-Type: application/json { "Hostname": "", "Domainname": "", "User": "", "AttachStdin": false, "AttachStdout": true, "AttachStderr": true, "PortSpecs": null, "Tty": false, "OpenStdin": false, "StdinOnce": false, "Env": null, "Cmd": [ "date" ], "Volumes": { "/tmp": {} }, "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, either in real time via streaming, or via polling (using since).
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
and Docker images report:
untag, delete
Example request:
GET /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:
event=<string>
; -- event to filterimage=<string>
; -- image to filtercontainer=<string>
; -- container 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 /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 /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 /images/load 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)/exec
Sets up an exec instance in a running container id
Example request:
POST /containers/e90e34656806/exec HTTP/1.1 Content-Type: application/json { "AttachStdin": false, "AttachStdout": true, "AttachStderr": true, "Tty": false, "Cmd": [ "date" ], }
Example response:
HTTP/1.1 201 OK Content-Type: application/json { "Id": "f90e34656806", "Warnings":[] }
Json Parameters:
stdin
of the exec
command.stdout
of the exec
command.stderr
of the exec
command.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 /exec/e90e34656806/start HTTP/1.1 Content-Type: application/json { "Detach": false, "Tty": false, }
Example response:
HTTP/1.1 201 OK Content-Type: application/json {{ STREAM }}
Json Parameters:
exec
command.Status Codes:
200 – no error
404 – no such exec instance
Stream details: Similar to the stream behavior of POST /container/(id)/attach
API
POST /exec/(id)/resize
Resizes the tty
session used by the exec
command id
. This API is valid only if tty
was specified as part of creating and starting the exec
command.
Example request:
POST /exec/e90e34656806/resize HTTP/1.1 Content-Type: text/plain
Example response:
HTTP/1.1 201 OK 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 /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, "PortSpecs": null, "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, "Volumes" : {}, "VolumesRW" : {} } }
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 remote api please give values to --api-cors-header
when running Docker in daemon mode. Set * (asterisk) allows all, default or blank means CORS disabled
$ docker -d -H="192.168.1.9:2375" --api-cors-header="http://foo.bar"