2014-05-16 11:47:33 +00:00
|
|
|
|
page_title: Remote API v1.12
|
|
|
|
|
page_description: API Documentation for Docker
|
|
|
|
|
page_keywords: API, Docker, rcli, REST, documentation
|
|
|
|
|
|
|
|
|
|
# Docker Remote API v1.12
|
|
|
|
|
|
|
|
|
|
## 1. Brief introduction
|
|
|
|
|
|
2014-06-09 00:59:22 +00:00
|
|
|
|
- The Remote API has replaced `rcli`.
|
2014-05-16 11:47:33 +00:00
|
|
|
|
- The daemon listens on `unix:///var/run/docker.sock` but you can
|
2014-10-15 06:48:43 +00:00
|
|
|
|
[Bind Docker to another host/port or a Unix socket](
|
|
|
|
|
/articles/basics/#bind-docker-to-another-hostport-or-a-unix-socket).
|
2014-05-16 11:47:33 +00:00
|
|
|
|
- The API tends to be REST, but for some complex commands, like `attach`
|
2014-06-09 00:59:22 +00:00
|
|
|
|
or `pull`, the HTTP connection is hijacked to transport `STDOUT`,
|
|
|
|
|
`STDIN` and `STDERR`.
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
# 2. Endpoints
|
|
|
|
|
|
|
|
|
|
## 2.1 Containers
|
|
|
|
|
|
|
|
|
|
### List containers
|
|
|
|
|
|
|
|
|
|
`GET /containers/json`
|
|
|
|
|
|
|
|
|
|
List containers
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
**Example request**:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
GET /containers/json?all=1&before=8dfafdbc3a40&size=1 HTTP/1.1
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
**Example response**:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
HTTP/1.1 200 OK
|
|
|
|
|
Content-Type: application/json
|
|
|
|
|
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"Id": "8dfafdbc3a40",
|
2015-01-16 13:04:24 +00:00
|
|
|
|
"Image": "ubuntu:latest",
|
2014-05-16 11:47:33 +00:00
|
|
|
|
"Command": "echo 1",
|
|
|
|
|
"Created": 1367854155,
|
|
|
|
|
"Status": "Exit 0",
|
2015-01-05 10:45:10 +00:00
|
|
|
|
"Ports": [{"PrivatePort": 2222, "PublicPort": 3333, "Type": "tcp"}],
|
|
|
|
|
"SizeRw": 12288,
|
|
|
|
|
"SizeRootFs": 0
|
2014-05-16 11:47:33 +00:00
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"Id": "9cd87474be90",
|
2015-01-16 13:04:24 +00:00
|
|
|
|
"Image": "ubuntu:latest",
|
2014-05-16 11:47:33 +00:00
|
|
|
|
"Command": "echo 222222",
|
|
|
|
|
"Created": 1367854155,
|
|
|
|
|
"Status": "Exit 0",
|
2015-01-05 10:45:10 +00:00
|
|
|
|
"Ports": [],
|
|
|
|
|
"SizeRw": 12288,
|
|
|
|
|
"SizeRootFs": 0
|
2014-05-16 11:47:33 +00:00
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"Id": "3176a2479c92",
|
2015-01-16 13:04:24 +00:00
|
|
|
|
"Image": "ubuntu:latest",
|
2014-05-16 11:47:33 +00:00
|
|
|
|
"Command": "echo 3333333333333333",
|
|
|
|
|
"Created": 1367854154,
|
|
|
|
|
"Status": "Exit 0",
|
|
|
|
|
"Ports":[],
|
|
|
|
|
"SizeRw":12288,
|
|
|
|
|
"SizeRootFs":0
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"Id": "4cb07b47f9fb",
|
2015-01-16 13:04:24 +00:00
|
|
|
|
"Image": "ubuntu:latest",
|
2014-05-16 11:47:33 +00:00
|
|
|
|
"Command": "echo 444444444444444444444444444444444",
|
|
|
|
|
"Created": 1367854152,
|
|
|
|
|
"Status": "Exit 0",
|
2015-01-05 10:45:10 +00:00
|
|
|
|
"Ports": [],
|
|
|
|
|
"SizeRw": 12288,
|
|
|
|
|
"SizeRootFs": 0
|
2014-05-16 11:47:33 +00:00
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
Query Parameters:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
- **all** – 1/True/true or 0/False/false, Show all containers.
|
|
|
|
|
Only running containers are shown by defaul
|
|
|
|
|
- **limit** – Show `limit` last created
|
2014-05-16 11:47:33 +00:00
|
|
|
|
containers, include non-running ones.
|
2014-09-09 05:00:23 +00:00
|
|
|
|
- **since** – Show only containers created since Id, include
|
2014-05-16 11:47:33 +00:00
|
|
|
|
non-running ones.
|
2014-09-09 05:00:23 +00:00
|
|
|
|
- **before** – Show only containers created before Id, include
|
2014-05-16 11:47:33 +00:00
|
|
|
|
non-running ones.
|
2014-09-09 05:00:23 +00:00
|
|
|
|
- **size** – 1/True/true or 0/False/false, Show the containers
|
2014-05-16 11:47:33 +00:00
|
|
|
|
sizes
|
2014-09-09 05:00:23 +00:00
|
|
|
|
- **filters** – a JSON encoded value of the filters (a map[string][]string)
|
2014-06-02 19:08:39 +00:00
|
|
|
|
to process on the images list.
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
Status Codes:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
- **200** – no error
|
|
|
|
|
- **400** – bad parameter
|
|
|
|
|
- **500** – server error
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
### Create a container
|
|
|
|
|
|
|
|
|
|
`POST /containers/create`
|
|
|
|
|
|
|
|
|
|
Create a container
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
**Example request**:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
POST /containers/create HTTP/1.1
|
|
|
|
|
Content-Type: application/json
|
|
|
|
|
|
|
|
|
|
{
|
|
|
|
|
"Hostname":"",
|
2014-09-01 18:41:42 +00:00
|
|
|
|
"Domainname": "",
|
2014-05-16 11:47:33 +00:00
|
|
|
|
"User":"",
|
|
|
|
|
"Memory":0,
|
|
|
|
|
"MemorySwap":0,
|
2014-09-01 18:41:42 +00:00
|
|
|
|
"CpuShares": 512,
|
|
|
|
|
"Cpuset": "0,1",
|
2014-05-16 11:47:33 +00:00
|
|
|
|
"AttachStdin":false,
|
|
|
|
|
"AttachStdout":true,
|
|
|
|
|
"AttachStderr":true,
|
|
|
|
|
"PortSpecs":null,
|
|
|
|
|
"Tty":false,
|
|
|
|
|
"OpenStdin":false,
|
|
|
|
|
"StdinOnce":false,
|
|
|
|
|
"Env":null,
|
|
|
|
|
"Cmd":[
|
|
|
|
|
"date"
|
|
|
|
|
],
|
2015-01-16 13:04:24 +00:00
|
|
|
|
"Image":"ubuntu",
|
2014-05-16 11:47:33 +00:00
|
|
|
|
"Volumes":{
|
|
|
|
|
"/tmp": {}
|
|
|
|
|
},
|
|
|
|
|
"WorkingDir":"",
|
2014-09-01 18:41:42 +00:00
|
|
|
|
"NetworkDisabled": false,
|
2014-05-16 11:47:33 +00:00
|
|
|
|
"ExposedPorts":{
|
|
|
|
|
"22/tcp": {}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
**Example response**:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-22 00:05:58 +00:00
|
|
|
|
HTTP/1.1 201 Created
|
2014-05-16 11:47:33 +00:00
|
|
|
|
Content-Type: application/json
|
|
|
|
|
|
|
|
|
|
{
|
|
|
|
|
"Id":"e90e34656806"
|
|
|
|
|
"Warnings":[]
|
|
|
|
|
}
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
Json Parameters:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
- **config** – the container's configuration
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
Query Parameters:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
- **name** – Assign the specified name to the container. Mus
|
2014-05-16 11:47:33 +00:00
|
|
|
|
match `/?[a-zA-Z0-9_-]+`.
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
Status Codes:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
- **201** – no error
|
|
|
|
|
- **404** – no such container
|
|
|
|
|
- **406** – impossible to attach (container not running)
|
|
|
|
|
- **500** – server error
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
### Inspect a container
|
|
|
|
|
|
|
|
|
|
`GET /containers/(id)/json`
|
|
|
|
|
|
|
|
|
|
Return low-level information on the container `id`
|
|
|
|
|
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
**Example request**:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
GET /containers/4fa6e0f0c678/json HTTP/1.1
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
**Example response**:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
HTTP/1.1 200 OK
|
|
|
|
|
Content-Type: application/json
|
|
|
|
|
|
|
|
|
|
{
|
|
|
|
|
"Id": "4fa6e0f0c6786287e131c3852c58a2e01cc697a68231826813597e4994f1d6e2",
|
|
|
|
|
"Created": "2013-05-07T14:51:42.041847+02:00",
|
|
|
|
|
"Path": "date",
|
|
|
|
|
"Args": [],
|
|
|
|
|
"Config": {
|
|
|
|
|
"Hostname": "4fa6e0f0c678",
|
|
|
|
|
"User": "",
|
|
|
|
|
"Memory": 0,
|
|
|
|
|
"MemorySwap": 0,
|
|
|
|
|
"AttachStdin": false,
|
|
|
|
|
"AttachStdout": true,
|
|
|
|
|
"AttachStderr": true,
|
|
|
|
|
"PortSpecs": null,
|
|
|
|
|
"Tty": false,
|
|
|
|
|
"OpenStdin": false,
|
|
|
|
|
"StdinOnce": false,
|
|
|
|
|
"Env": null,
|
|
|
|
|
"Cmd": [
|
|
|
|
|
"date"
|
|
|
|
|
],
|
|
|
|
|
"Dns": null,
|
2015-01-16 13:04:24 +00:00
|
|
|
|
"Image": "ubuntu",
|
2014-05-16 11:47:33 +00:00
|
|
|
|
"Volumes": {},
|
|
|
|
|
"VolumesFrom": "",
|
2015-01-05 10:45:10 +00:00
|
|
|
|
"WorkingDir": ""
|
2014-05-16 11:47:33 +00:00
|
|
|
|
},
|
|
|
|
|
"State": {
|
|
|
|
|
"Running": false,
|
|
|
|
|
"Pid": 0,
|
|
|
|
|
"ExitCode": 0,
|
|
|
|
|
"StartedAt": "2013-05-07T14:51:42.087658+02:01360",
|
|
|
|
|
"Ghost": false
|
|
|
|
|
},
|
|
|
|
|
"Image": "b750fe79269d2ec9a3c593ef05b4332b1d1a02a62b4accb2c21d589ff2f5f2dc",
|
|
|
|
|
"NetworkSettings": {
|
|
|
|
|
"IpAddress": "",
|
|
|
|
|
"IpPrefixLen": 0,
|
|
|
|
|
"Gateway": "",
|
|
|
|
|
"Bridge": "",
|
|
|
|
|
"PortMapping": null
|
|
|
|
|
},
|
2014-07-24 22:19:50 +00:00
|
|
|
|
"SysInitPath": "/home/kitty/go/src/github.com/docker/docker/bin/docker",
|
2014-05-16 11:47:33 +00:00
|
|
|
|
"ResolvConfPath": "/etc/resolv.conf",
|
|
|
|
|
"Volumes": {},
|
|
|
|
|
"HostConfig": {
|
|
|
|
|
"Binds": null,
|
|
|
|
|
"ContainerIDFile": "",
|
|
|
|
|
"LxcConf": [],
|
|
|
|
|
"Privileged": false,
|
|
|
|
|
"PortBindings": {
|
|
|
|
|
"80/tcp": [
|
|
|
|
|
{
|
|
|
|
|
"HostIp": "0.0.0.0",
|
|
|
|
|
"HostPort": "49153"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
},
|
|
|
|
|
"Links": null,
|
|
|
|
|
"PublishAllPorts": false
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
Status Codes:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
- **200** – no error
|
|
|
|
|
- **404** – no such container
|
|
|
|
|
- **500** – server error
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
### List processes running inside a container
|
|
|
|
|
|
|
|
|
|
`GET /containers/(id)/top`
|
|
|
|
|
|
|
|
|
|
List processes running inside the container `id`
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
**Example request**:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
GET /containers/4fa6e0f0c678/top HTTP/1.1
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
**Example response**:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
HTTP/1.1 200 OK
|
|
|
|
|
Content-Type: application/json
|
|
|
|
|
|
|
|
|
|
{
|
2015-01-05 10:45:10 +00:00
|
|
|
|
"Titles": [
|
2014-05-16 11:47:33 +00:00
|
|
|
|
"USER",
|
|
|
|
|
"PID",
|
|
|
|
|
"%CPU",
|
|
|
|
|
"%MEM",
|
|
|
|
|
"VSZ",
|
|
|
|
|
"RSS",
|
|
|
|
|
"TTY",
|
|
|
|
|
"STAT",
|
|
|
|
|
"START",
|
|
|
|
|
"TIME",
|
|
|
|
|
"COMMAND"
|
|
|
|
|
],
|
2015-01-05 10:45:10 +00:00
|
|
|
|
"Processes": [
|
2014-05-16 11:47:33 +00:00
|
|
|
|
["root","20147","0.0","0.1","18060","1864","pts/4","S","10:06","0:00","bash"],
|
|
|
|
|
["root","20271","0.0","0.0","4312","352","pts/4","S+","10:07","0:00","sleep","10"]
|
|
|
|
|
]
|
|
|
|
|
}
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
Query Parameters:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
- **ps_args** – ps arguments to use (e.g., aux)
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
Status Codes:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
- **200** – no error
|
|
|
|
|
- **404** – no such container
|
|
|
|
|
- **500** – server error
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
### Get container logs
|
|
|
|
|
|
|
|
|
|
`GET /containers/(id)/logs`
|
|
|
|
|
|
|
|
|
|
Get stdout and stderr logs from the container ``id``
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
**Example request**:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
GET /containers/4fa6e0f0c678/logs?stderr=1&stdout=1×tamps=1&follow=1 HTTP/1.1
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
**Example response**:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
HTTP/1.1 200 OK
|
|
|
|
|
Content-Type: application/vnd.docker.raw-stream
|
|
|
|
|
|
|
|
|
|
{{ STREAM }}
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
Query Parameters:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
- **follow** – 1/True/true or 0/False/false, return stream.
|
2014-05-16 11:47:33 +00:00
|
|
|
|
Default false
|
2014-09-09 05:00:23 +00:00
|
|
|
|
- **stdout** – 1/True/true or 0/False/false, if logs=true, return
|
2014-05-16 11:47:33 +00:00
|
|
|
|
stdout log. Default false
|
2014-09-09 05:00:23 +00:00
|
|
|
|
- **stderr** – 1/True/true or 0/False/false, if logs=true, return
|
2014-05-16 11:47:33 +00:00
|
|
|
|
stderr log. Default false
|
2014-09-09 05:00:23 +00:00
|
|
|
|
- **timestamps** – 1/True/true or 0/False/false, if logs=true, prin
|
2014-05-16 11:47:33 +00:00
|
|
|
|
timestamps for every log line. Default false
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
Status Codes:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
- **200** – no error
|
|
|
|
|
- **404** – no such container
|
|
|
|
|
- **500** – server error
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
### Inspect changes on a container's filesystem
|
|
|
|
|
|
|
|
|
|
`GET /containers/(id)/changes`
|
|
|
|
|
|
|
|
|
|
Inspect changes on container `id`'s filesystem
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
**Example request**:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
GET /containers/4fa6e0f0c678/changes HTTP/1.1
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
**Example response**:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
HTTP/1.1 200 OK
|
|
|
|
|
Content-Type: application/json
|
|
|
|
|
|
|
|
|
|
[
|
|
|
|
|
{
|
2015-01-05 10:45:10 +00:00
|
|
|
|
"Path": "/dev",
|
|
|
|
|
"Kind": 0
|
2014-05-16 11:47:33 +00:00
|
|
|
|
},
|
|
|
|
|
{
|
2015-01-05 10:45:10 +00:00
|
|
|
|
"Path": "/dev/kmsg",
|
|
|
|
|
"Kind": 1
|
2014-05-16 11:47:33 +00:00
|
|
|
|
},
|
|
|
|
|
{
|
2015-01-05 10:45:10 +00:00
|
|
|
|
"Path": "/test",
|
|
|
|
|
"Kind": 1
|
2014-05-16 11:47:33 +00:00
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
Status Codes:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
- **200** – no error
|
|
|
|
|
- **404** – no such container
|
|
|
|
|
- **500** – server error
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
### Export a container
|
|
|
|
|
|
|
|
|
|
`GET /containers/(id)/export`
|
|
|
|
|
|
|
|
|
|
Export the contents of container `id`
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
**Example request**:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
GET /containers/4fa6e0f0c678/export HTTP/1.1
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
**Example response**:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
HTTP/1.1 200 OK
|
|
|
|
|
Content-Type: application/octet-stream
|
|
|
|
|
|
2014-09-08 01:51:57 +00:00
|
|
|
|
{{ TAR STREAM }}
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
Status Codes:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
- **200** – no error
|
|
|
|
|
- **404** – no such container
|
|
|
|
|
- **500** – server error
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
### Start a container
|
|
|
|
|
|
|
|
|
|
`POST /containers/(id)/start`
|
|
|
|
|
|
|
|
|
|
Start the container `id`
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
**Example request**:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
POST /containers/(id)/start HTTP/1.1
|
|
|
|
|
Content-Type: application/json
|
|
|
|
|
|
|
|
|
|
{
|
|
|
|
|
"Binds":["/tmp:/tmp"],
|
2014-06-12 09:15:14 +00:00
|
|
|
|
"Links":["redis3:redis"],
|
2014-08-26 01:35:58 +00:00
|
|
|
|
"LxcConf":[{"Key":"lxc.utsname","Value":"docker"}],
|
2014-05-16 11:47:33 +00:00
|
|
|
|
"PortBindings":{ "22/tcp": [{ "HostPort": "11022" }] },
|
|
|
|
|
"PublishAllPorts":false,
|
2014-06-05 13:50:27 +00:00
|
|
|
|
"Privileged":false,
|
|
|
|
|
"Dns": ["8.8.8.8"],
|
|
|
|
|
"VolumesFrom": ["parent", "other:ro"]
|
2014-05-16 11:47:33 +00:00
|
|
|
|
}
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
**Example response**:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-11-18 19:32:23 +00:00
|
|
|
|
HTTP/1.1 204 No Content
|
2014-05-16 11:47:33 +00:00
|
|
|
|
Content-Type: text/plain
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
Json Parameters:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
- **hostConfig** – the container's host configuration (optional)
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
Status Codes:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
- **204** – no error
|
|
|
|
|
- **404** – no such container
|
|
|
|
|
- **500** – server error
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
### Stop a container
|
|
|
|
|
|
|
|
|
|
`POST /containers/(id)/stop`
|
|
|
|
|
|
|
|
|
|
Stop the container `id`
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
**Example request**:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
POST /containers/e90e34656806/stop?t=5 HTTP/1.1
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
**Example response**:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-22 00:05:58 +00:00
|
|
|
|
HTTP/1.1 204 No Content
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
Query Parameters:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
- **t** – number of seconds to wait before killing the container
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
Status Codes:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
- **204** – no error
|
|
|
|
|
- **404** – no such container
|
|
|
|
|
- **500** – server error
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
### Restart a container
|
|
|
|
|
|
|
|
|
|
`POST /containers/(id)/restart`
|
|
|
|
|
|
|
|
|
|
Restart the container `id`
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
**Example request**:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
POST /containers/e90e34656806/restart?t=5 HTTP/1.1
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
**Example response**:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-22 00:05:58 +00:00
|
|
|
|
HTTP/1.1 204 No Content
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
Query Parameters:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
- **t** – number of seconds to wait before killing the container
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
Status Codes:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
- **204** – no error
|
|
|
|
|
- **404** – no such container
|
|
|
|
|
- **500** – server error
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
### Kill a container
|
|
|
|
|
|
|
|
|
|
`POST /containers/(id)/kill`
|
|
|
|
|
|
|
|
|
|
Kill the container `id`
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
**Example request**:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
POST /containers/e90e34656806/kill HTTP/1.1
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
**Example response**:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-22 00:05:58 +00:00
|
|
|
|
HTTP/1.1 204 No Content
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
Query Parameters
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
- **signal** - Signal to send to the container: integer or string like "SIGINT".
|
2014-09-22 00:05:58 +00:00
|
|
|
|
When not set, SIGKILL is assumed and the call will wait for the container to exit.
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
Status Codes:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
- **204** – no error
|
|
|
|
|
- **404** – no such container
|
|
|
|
|
- **500** – server error
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-06-24 22:17:52 +00:00
|
|
|
|
### Pause a container
|
|
|
|
|
|
|
|
|
|
`POST /containers/(id)/pause`
|
|
|
|
|
|
|
|
|
|
Pause the container `id`
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
**Example request**:
|
2014-06-24 22:17:52 +00:00
|
|
|
|
|
|
|
|
|
POST /containers/e90e34656806/pause HTTP/1.1
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
**Example response**:
|
2014-06-24 22:17:52 +00:00
|
|
|
|
|
2014-09-22 00:05:58 +00:00
|
|
|
|
HTTP/1.1 204 No Content
|
2014-06-24 22:17:52 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
Status Codes:
|
2014-06-24 22:17:52 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
- **204** – no error
|
|
|
|
|
- **404** – no such container
|
|
|
|
|
- **500** – server error
|
2014-06-24 22:17:52 +00:00
|
|
|
|
|
|
|
|
|
### Unpause a container
|
|
|
|
|
|
|
|
|
|
`POST /containers/(id)/unpause`
|
|
|
|
|
|
|
|
|
|
Unpause the container `id`
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
**Example request**:
|
2014-06-24 22:17:52 +00:00
|
|
|
|
|
|
|
|
|
POST /containers/e90e34656806/unpause HTTP/1.1
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
**Example response**:
|
2014-06-24 22:17:52 +00:00
|
|
|
|
|
2014-09-22 00:05:58 +00:00
|
|
|
|
HTTP/1.1 204 No Content
|
2014-06-24 22:17:52 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
Status Codes:
|
2014-06-24 22:17:52 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
- **204** – no error
|
|
|
|
|
- **404** – no such container
|
|
|
|
|
- **500** – server error
|
2014-06-24 22:17:52 +00:00
|
|
|
|
|
2014-05-16 11:47:33 +00:00
|
|
|
|
### Attach to a container
|
|
|
|
|
|
|
|
|
|
`POST /containers/(id)/attach`
|
|
|
|
|
|
|
|
|
|
Attach to the container `id`
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
**Example request**:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
POST /containers/16253994b7c4/attach?logs=1&stream=0&stdout=1 HTTP/1.1
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
**Example response**:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
HTTP/1.1 200 OK
|
|
|
|
|
Content-Type: application/vnd.docker.raw-stream
|
|
|
|
|
|
|
|
|
|
{{ STREAM }}
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
Query Parameters:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-22 00:05:58 +00:00
|
|
|
|
- **logs** – 1/True/true or 0/False/false, return logs. Default false
|
|
|
|
|
- **stream** – 1/True/true or 0/False/false, return stream. Default false
|
|
|
|
|
- **stdin** – 1/True/true or 0/False/false, if stream=true, attach to stdin.
|
|
|
|
|
Default false
|
2014-09-09 05:00:23 +00:00
|
|
|
|
- **stdout** – 1/True/true or 0/False/false, if logs=true, return
|
2014-09-22 00:05:58 +00:00
|
|
|
|
stdout log, if stream=true, attach to stdout. Default false
|
2014-09-09 05:00:23 +00:00
|
|
|
|
- **stderr** – 1/True/true or 0/False/false, if logs=true, return
|
2014-09-22 00:05:58 +00:00
|
|
|
|
stderr log, if stream=true, attach to stderr. Default false
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
Status Codes:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
- **200** – no error
|
|
|
|
|
- **400** – bad parameter
|
|
|
|
|
- **404** – no such container
|
|
|
|
|
- **500** – server error
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
**Stream details**:
|
|
|
|
|
|
|
|
|
|
When using the TTY setting is enabled in
|
|
|
|
|
[`POST /containers/create`
|
2014-12-16 04:25:37 +00:00
|
|
|
|
](/reference/api/docker_remote_api_v1.9/#create-a-container "POST /containers/create"),
|
2014-05-16 11:47:33 +00:00
|
|
|
|
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 will contain the information on which stream write the
|
|
|
|
|
stream (stdout or stderr). It also contain the size of the
|
|
|
|
|
associated frame encoded on the last 4 bytes (uint32).
|
|
|
|
|
|
|
|
|
|
It is encoded on the first 8 bytes like this:
|
|
|
|
|
|
|
|
|
|
header := [8]byte{STREAM_TYPE, 0, 0, 0, SIZE1, SIZE2, SIZE3, SIZE4}
|
|
|
|
|
|
|
|
|
|
`STREAM_TYPE` can be:
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
- 0: stdin (will be written on stdout)
|
2014-11-03 10:52:50 +00:00
|
|
|
|
- 1: stdout
|
2014-09-09 05:00:23 +00:00
|
|
|
|
- 2: stderr
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
`SIZE1, SIZE2, SIZE3, SIZE4` are the 4 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 8 bytes
|
|
|
|
|
2. chose stdout or stderr depending on the first byte
|
2015-04-11 10:11:49 +00:00
|
|
|
|
3. Extract the frame size from the last 4 bytes
|
2014-09-11 09:09:59 +00:00
|
|
|
|
4. Read the extracted size and output it on the correct output
|
2014-09-22 00:05:58 +00:00
|
|
|
|
5. Goto 1
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2015-01-21 19:52:35 +00:00
|
|
|
|
### Attach to a container (websocket)
|
|
|
|
|
|
|
|
|
|
`GET /containers/(id)/attach/ws`
|
|
|
|
|
|
|
|
|
|
Attach to the container `id` via websocket
|
|
|
|
|
|
|
|
|
|
Implements websocket protocol handshake according to [RFC 6455](http://tools.ietf.org/html/rfc6455)
|
|
|
|
|
|
|
|
|
|
**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:
|
|
|
|
|
|
|
|
|
|
- **logs** – 1/True/true or 0/False/false, return logs. Default false
|
|
|
|
|
- **stream** – 1/True/true or 0/False/false, return stream.
|
|
|
|
|
Default false
|
|
|
|
|
- **stdin** – 1/True/true or 0/False/false, if stream=true, attach
|
|
|
|
|
to stdin. Default false
|
|
|
|
|
- **stdout** – 1/True/true or 0/False/false, if logs=true, return
|
|
|
|
|
stdout log, if stream=true, attach to stdout. Default false
|
|
|
|
|
- **stderr** – 1/True/true or 0/False/false, if logs=true, return
|
|
|
|
|
stderr log, if stream=true, attach to stderr. Default false
|
|
|
|
|
|
|
|
|
|
Status Codes:
|
|
|
|
|
|
|
|
|
|
- **200** – no error
|
|
|
|
|
- **400** – bad parameter
|
|
|
|
|
- **404** – no such container
|
|
|
|
|
- **500** – server error
|
|
|
|
|
|
2014-05-16 11:47:33 +00:00
|
|
|
|
### Wait a container
|
|
|
|
|
|
|
|
|
|
`POST /containers/(id)/wait`
|
|
|
|
|
|
|
|
|
|
Block until container `id` stops, then returns the exit code
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
**Example request**:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
POST /containers/16253994b7c4/wait HTTP/1.1
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
**Example response**:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
HTTP/1.1 200 OK
|
|
|
|
|
Content-Type: application/json
|
|
|
|
|
|
2015-01-05 10:45:10 +00:00
|
|
|
|
{"StatusCode": 0}
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
Status Codes:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
- **200** – no error
|
|
|
|
|
- **404** – no such container
|
|
|
|
|
- **500** – server error
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
### Remove a container
|
|
|
|
|
|
|
|
|
|
`DELETE /containers/(id)`
|
|
|
|
|
|
|
|
|
|
Remove the container `id` from the filesystem
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
**Example request**:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
DELETE /containers/16253994b7c4?v=1 HTTP/1.1
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
**Example response**:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-22 00:05:58 +00:00
|
|
|
|
HTTP/1.1 204 No Content
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
Query Parameters:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
- **v** – 1/True/true or 0/False/false, Remove the volumes
|
2014-05-16 11:47:33 +00:00
|
|
|
|
associated to the container. Default false
|
2014-09-09 05:00:23 +00:00
|
|
|
|
- **force** – 1/True/true or 0/False/false, Removes the container
|
2014-05-16 11:47:33 +00:00
|
|
|
|
even if it was running. Default false
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
Status Codes:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
- **204** – no error
|
|
|
|
|
- **400** – bad parameter
|
|
|
|
|
- **404** – no such container
|
|
|
|
|
- **500** – server error
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
### Copy files or folders from a container
|
|
|
|
|
|
|
|
|
|
`POST /containers/(id)/copy`
|
|
|
|
|
|
|
|
|
|
Copy files or folders of container `id`
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
**Example request**:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
POST /containers/4fa6e0f0c678/copy HTTP/1.1
|
|
|
|
|
Content-Type: application/json
|
|
|
|
|
|
|
|
|
|
{
|
2015-01-05 10:45:10 +00:00
|
|
|
|
"Resource": "test.txt"
|
2014-05-16 11:47:33 +00:00
|
|
|
|
}
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
**Example response**:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
HTTP/1.1 200 OK
|
|
|
|
|
Content-Type: application/octet-stream
|
|
|
|
|
|
2014-09-08 01:51:57 +00:00
|
|
|
|
{{ TAR STREAM }}
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
Status Codes:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
- **200** – no error
|
|
|
|
|
- **404** – no such container
|
|
|
|
|
- **500** – server error
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
## 2.2 Images
|
|
|
|
|
|
|
|
|
|
### List Images
|
|
|
|
|
|
|
|
|
|
`GET /images/json`
|
|
|
|
|
|
|
|
|
|
**Example request**:
|
|
|
|
|
|
|
|
|
|
GET /images/json?all=0 HTTP/1.1
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
**Example response**:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
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
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"RepoTags": [
|
|
|
|
|
"ubuntu:12.10",
|
|
|
|
|
"ubuntu:quantal"
|
|
|
|
|
],
|
|
|
|
|
"ParentId": "27cf784147099545",
|
|
|
|
|
"Id": "b750fe79269d2ec9a3c593ef05b4332b1d1a02a62b4accb2c21d589ff2f5f2dc",
|
|
|
|
|
"Created": 1364102658,
|
|
|
|
|
"Size": 24653,
|
|
|
|
|
"VirtualSize": 180116135
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
|
2014-05-30 20:42:37 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
Query Parameters:
|
2014-05-30 20:42:37 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
- **all** – 1/True/true or 0/False/false, default false
|
2014-12-15 15:28:42 +00:00
|
|
|
|
- **filters** – a json encoded value of the filters (a map[string][]string) to process on the images list. Available filters:
|
|
|
|
|
- dangling=true
|
2014-06-24 22:17:52 +00:00
|
|
|
|
|
2014-05-30 20:42:37 +00:00
|
|
|
|
|
|
|
|
|
|
2014-05-16 11:47:33 +00:00
|
|
|
|
### Create an image
|
|
|
|
|
|
|
|
|
|
`POST /images/create`
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
Create an image, either by pull it from the registry or by importing i
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
**Example request**:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2015-01-16 13:04:24 +00:00
|
|
|
|
POST /images/create?fromImage=ubuntu HTTP/1.1
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
**Example response**:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
HTTP/1.1 200 OK
|
|
|
|
|
Content-Type: application/json
|
|
|
|
|
|
2015-01-05 10:45:10 +00:00
|
|
|
|
{"status": "Pulling..."}
|
|
|
|
|
{"status": "Pulling", "progress": "1 B/ 100 B", "progressDetail": {"current": 1, "total": 100}}
|
|
|
|
|
{"error": "Invalid..."}
|
2014-05-16 11:47:33 +00:00
|
|
|
|
...
|
|
|
|
|
|
|
|
|
|
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.
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
Query Parameters:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
- **fromImage** – name of the image to pull
|
|
|
|
|
- **fromSrc** – source to import, - means stdin
|
|
|
|
|
- **repo** – repository
|
|
|
|
|
- **tag** – tag
|
|
|
|
|
- **registry** – the registry to pull from
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-22 00:05:58 +00:00
|
|
|
|
Request Headers:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-22 00:05:58 +00:00
|
|
|
|
- **X-Registry-Auth** – base64-encoded AuthConfig object
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
Status Codes:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
- **200** – no error
|
|
|
|
|
- **500** – server error
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### Inspect an image
|
|
|
|
|
|
|
|
|
|
`GET /images/(name)/json`
|
|
|
|
|
|
|
|
|
|
Return low-level information on the image `name`
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
**Example request**:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2015-01-16 13:04:24 +00:00
|
|
|
|
GET /images/ubuntu/json HTTP/1.1
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
**Example response**:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
HTTP/1.1 200 OK
|
|
|
|
|
Content-Type: application/json
|
|
|
|
|
|
|
|
|
|
{
|
2015-01-05 10:45:10 +00:00
|
|
|
|
"Created": "2013-03-23T22:24:18.818426-07:00",
|
|
|
|
|
"Container": "3d67245a8d72ecf13f33dffac9f79dcdf70f75acb84d308770391510e0c23ad0",
|
2014-05-31 01:28:08 +00:00
|
|
|
|
"ContainerConfig":
|
2014-05-16 11:47:33 +00:00
|
|
|
|
{
|
2015-01-05 10:45:10 +00:00
|
|
|
|
"Hostname": "",
|
|
|
|
|
"User": "",
|
|
|
|
|
"Memory": 0,
|
|
|
|
|
"MemorySwap": 0,
|
|
|
|
|
"AttachStdin": false,
|
|
|
|
|
"AttachStdout": false,
|
|
|
|
|
"AttachStderr": false,
|
|
|
|
|
"PortSpecs": null,
|
|
|
|
|
"Tty": true,
|
|
|
|
|
"OpenStdin": true,
|
|
|
|
|
"StdinOnce": false,
|
|
|
|
|
"Env": null,
|
2014-06-27 11:32:01 +00:00
|
|
|
|
"Cmd": ["/bin/bash"],
|
2015-01-05 10:45:10 +00:00
|
|
|
|
"Dns": null,
|
2015-01-16 13:04:24 +00:00
|
|
|
|
"Image": "ubuntu",
|
2015-01-05 10:45:10 +00:00
|
|
|
|
"Volumes": null,
|
|
|
|
|
"VolumesFrom": "",
|
|
|
|
|
"WorkingDir": ""
|
2014-05-16 11:47:33 +00:00
|
|
|
|
},
|
2015-01-05 10:45:10 +00:00
|
|
|
|
"Id": "b750fe79269d2ec9a3c593ef05b4332b1d1a02a62b4accb2c21d589ff2f5f2dc",
|
|
|
|
|
"Parent": "27cf784147099545",
|
2014-05-16 11:47:33 +00:00
|
|
|
|
"Size": 6824592
|
|
|
|
|
}
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
Status Codes:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
- **200** – no error
|
|
|
|
|
- **404** – no such image
|
|
|
|
|
- **500** – server error
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
### Get the history of an image
|
|
|
|
|
|
|
|
|
|
`GET /images/(name)/history`
|
|
|
|
|
|
|
|
|
|
Return the history of the image `name`
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
**Example request**:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2015-01-16 13:04:24 +00:00
|
|
|
|
GET /images/ubuntu/history HTTP/1.1
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
**Example response**:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
HTTP/1.1 200 OK
|
|
|
|
|
Content-Type: application/json
|
|
|
|
|
|
|
|
|
|
[
|
|
|
|
|
{
|
2015-01-05 10:45:10 +00:00
|
|
|
|
"Id": "b750fe79269d",
|
|
|
|
|
"Created": 1364102658,
|
|
|
|
|
"CreatedBy": "/bin/bash"
|
2014-05-16 11:47:33 +00:00
|
|
|
|
},
|
|
|
|
|
{
|
2015-01-05 10:45:10 +00:00
|
|
|
|
"Id": "27cf78414709",
|
|
|
|
|
"Created": 1364068391,
|
|
|
|
|
"CreatedBy": ""
|
2014-05-16 11:47:33 +00:00
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
Status Codes:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
- **200** – no error
|
|
|
|
|
- **404** – no such image
|
|
|
|
|
- **500** – server error
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
### Push an image on the registry
|
|
|
|
|
|
|
|
|
|
`POST /images/(name)/push`
|
|
|
|
|
|
|
|
|
|
Push the image `name` on the registry
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
**Example request**:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
POST /images/test/push HTTP/1.1
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
**Example response**:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
HTTP/1.1 200 OK
|
|
|
|
|
Content-Type: application/json
|
|
|
|
|
|
2015-01-05 10:45:10 +00:00
|
|
|
|
{"status": "Pushing..."}
|
|
|
|
|
{"status": "Pushing", "progress": "1/? (n/a)", "progressDetail": {"current": 1}}}
|
|
|
|
|
{"error": "Invalid..."}
|
2014-05-16 11:47:33 +00:00
|
|
|
|
...
|
|
|
|
|
|
2014-08-01 02:26:32 +00:00
|
|
|
|
If you wish to push an image on to a private registry, that image must already have been tagged
|
2014-09-09 05:00:23 +00:00
|
|
|
|
into a repository which references that registry host name and port. This repository name should
|
2014-08-01 02:26:32 +00:00
|
|
|
|
then be used in the URL. This mirrors the flow of the CLI.
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
**Example request**:
|
|
|
|
|
|
|
|
|
|
POST /images/registry.acme.com:5000/test/push HTTP/1.1
|
2014-08-01 02:26:32 +00:00
|
|
|
|
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
Query Parameters:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
- **tag** – the tag to associate with the image on the registry, optional
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-22 00:05:58 +00:00
|
|
|
|
Request Headers:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-22 00:05:58 +00:00
|
|
|
|
- **X-Registry-Auth** – include a base64-encoded AuthConfig object.
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
Status Codes:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
- **200** – no error
|
|
|
|
|
- **404** – no such image
|
|
|
|
|
- **500** – server error
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
### Tag an image into a repository
|
|
|
|
|
|
|
|
|
|
`POST /images/(name)/tag`
|
|
|
|
|
|
|
|
|
|
Tag the image `name` into a repository
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
**Example request**:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-30 15:23:20 +00:00
|
|
|
|
POST /images/test/tag?repo=myrepo&force=0&tag=v42 HTTP/1.1
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
**Example response**:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
HTTP/1.1 201 OK
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
Query Parameters:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
- **repo** – The repository to tag in
|
|
|
|
|
- **force** – 1/True/true or 0/False/false, default false
|
2014-09-30 15:23:20 +00:00
|
|
|
|
- **tag** - The new tag name
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
Status Codes:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
- **201** – no error
|
|
|
|
|
- **400** – bad parameter
|
|
|
|
|
- **404** – no such image
|
2014-09-12 14:49:59 +00:00
|
|
|
|
- **409** – conflict
|
2014-09-09 05:00:23 +00:00
|
|
|
|
- **500** – server error
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
### Remove an image
|
|
|
|
|
|
|
|
|
|
`DELETE /images/(name)`
|
|
|
|
|
|
|
|
|
|
Remove the image `name` from the filesystem
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
**Example request**:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
DELETE /images/test HTTP/1.1
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
**Example response**:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
HTTP/1.1 200 OK
|
|
|
|
|
Content-type: application/json
|
|
|
|
|
|
|
|
|
|
[
|
2015-01-05 10:45:10 +00:00
|
|
|
|
{"Untagged": "3e2f21a89f"},
|
|
|
|
|
{"Deleted": "3e2f21a89f"},
|
|
|
|
|
{"Deleted": "53b4f83ac9"}
|
2014-05-16 11:47:33 +00:00
|
|
|
|
]
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
Query Parameters:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
- **force** – 1/True/true or 0/False/false, default false
|
|
|
|
|
- **noprune** – 1/True/true or 0/False/false, default false
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
Status Codes:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
- **200** – no error
|
|
|
|
|
- **404** – no such image
|
2014-09-12 14:49:59 +00:00
|
|
|
|
- **409** – conflict
|
2014-09-09 05:00:23 +00:00
|
|
|
|
- **500** – server error
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
### Search images
|
|
|
|
|
|
|
|
|
|
`GET /images/search`
|
|
|
|
|
|
2014-06-01 20:48:04 +00:00
|
|
|
|
Search for an image on [Docker Hub](https://hub.docker.com).
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
> **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.
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
**Example request**:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
GET /images/search?term=sshd HTTP/1.1
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
**Example response**:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
HTTP/1.1 200 OK
|
|
|
|
|
Content-Type: application/json
|
|
|
|
|
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"description": "",
|
|
|
|
|
"is_official": false,
|
2014-06-02 18:48:58 +00:00
|
|
|
|
"is_automated": false,
|
2014-05-16 11:47:33 +00:00
|
|
|
|
"name": "wma55/u1210sshd",
|
|
|
|
|
"star_count": 0
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"description": "",
|
|
|
|
|
"is_official": false,
|
2014-06-02 18:48:58 +00:00
|
|
|
|
"is_automated": false,
|
2014-05-16 11:47:33 +00:00
|
|
|
|
"name": "jdswinbank/sshd",
|
|
|
|
|
"star_count": 0
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"description": "",
|
|
|
|
|
"is_official": false,
|
2014-06-02 18:48:58 +00:00
|
|
|
|
"is_automated": false,
|
2014-05-16 11:47:33 +00:00
|
|
|
|
"name": "vgauthier/sshd",
|
|
|
|
|
"star_count": 0
|
|
|
|
|
}
|
|
|
|
|
...
|
|
|
|
|
]
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
Query Parameters:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
- **term** – term to search
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
Status Codes:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
- **200** – no error
|
|
|
|
|
- **500** – server error
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
## 2.3 Misc
|
|
|
|
|
|
|
|
|
|
### Build an image from Dockerfile via stdin
|
|
|
|
|
|
|
|
|
|
`POST /build`
|
|
|
|
|
|
|
|
|
|
Build an image from Dockerfile via stdin
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
**Example request**:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
POST /build HTTP/1.1
|
|
|
|
|
|
2014-09-08 01:51:57 +00:00
|
|
|
|
{{ TAR STREAM }}
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
**Example response**:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
HTTP/1.1 200 OK
|
|
|
|
|
Content-Type: application/json
|
|
|
|
|
|
2015-01-05 10:45:10 +00:00
|
|
|
|
{"stream": "Step 1..."}
|
|
|
|
|
{"stream": "..."}
|
|
|
|
|
{"error": "Error...", "errorDetail": {"code": 123, "message": "Error..."}}
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
The stream must be a tar archive compressed with one of the
|
|
|
|
|
following algorithms: identity (no compression), gzip, bzip2, xz.
|
|
|
|
|
|
|
|
|
|
The archive must include a file called `Dockerfile`
|
|
|
|
|
at its root. It may include any number of other files,
|
|
|
|
|
which will be accessible in the build context (See the [*ADD build
|
|
|
|
|
command*](/reference/builder/#dockerbuilder)).
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
Query Parameters:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
- **t** – repository name (and optionally a tag) to be applied to
|
2014-09-22 00:05:58 +00:00
|
|
|
|
the resulting image in case of success
|
2015-02-04 15:03:06 +00:00
|
|
|
|
- **remote** – git or HTTP/HTTPS URI build source
|
2014-09-11 09:09:59 +00:00
|
|
|
|
- **q** – suppress verbose build output
|
2014-09-09 05:00:23 +00:00
|
|
|
|
- **nocache** – do not use the cache when building the image
|
|
|
|
|
- **rm** - remove intermediate containers after a successful build (default behavior)
|
2014-12-04 17:30:16 +00:00
|
|
|
|
- **forcerm** - always remove intermediate containers (includes rm)
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
Request Headers:
|
|
|
|
|
|
2014-09-22 00:05:58 +00:00
|
|
|
|
- **Content-type** – should be set to `"application/tar"`.
|
2014-09-09 05:00:23 +00:00
|
|
|
|
- **X-Registry-Config** – base64-encoded ConfigFile objec
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
Status Codes:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
- **200** – no error
|
|
|
|
|
- **500** – server error
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
### Check auth configuration
|
|
|
|
|
|
|
|
|
|
`POST /auth`
|
|
|
|
|
|
|
|
|
|
Get the default username and email
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
**Example request**:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
POST /auth HTTP/1.1
|
|
|
|
|
Content-Type: application/json
|
|
|
|
|
|
|
|
|
|
{
|
2015-01-05 10:45:10 +00:00
|
|
|
|
"username":" hannibal",
|
|
|
|
|
"password: "xxxx",
|
|
|
|
|
"email": "hannibal@a-team.com",
|
|
|
|
|
"serveraddress": "https://index.docker.io/v1/"
|
2014-05-16 11:47:33 +00:00
|
|
|
|
}
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
**Example response**:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
HTTP/1.1 200 OK
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
Status Codes:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
- **200** – no error
|
|
|
|
|
- **204** – no error
|
|
|
|
|
- **500** – server error
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
### Display system-wide information
|
|
|
|
|
|
|
|
|
|
`GET /info`
|
|
|
|
|
|
|
|
|
|
Display system-wide information
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
**Example request**:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
GET /info HTTP/1.1
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
**Example response**:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
HTTP/1.1 200 OK
|
|
|
|
|
Content-Type: application/json
|
|
|
|
|
|
|
|
|
|
{
|
2015-01-05 10:45:10 +00:00
|
|
|
|
"Containers": 11,
|
|
|
|
|
"Images": 16,
|
|
|
|
|
"Driver": "btrfs",
|
|
|
|
|
"ExecutionDriver": "native-0.1",
|
|
|
|
|
"KernelVersion": "3.12.0-1-amd64"
|
|
|
|
|
"Debug": false,
|
2014-05-16 11:47:33 +00:00
|
|
|
|
"NFd": 11,
|
2015-01-05 10:45:10 +00:00
|
|
|
|
"NGoroutines": 21,
|
|
|
|
|
"NEventsListener": 0,
|
|
|
|
|
"InitPath": "/usr/bin/docker",
|
|
|
|
|
"IndexServerAddress": ["https://index.docker.io/v1/"],
|
|
|
|
|
"MemoryLimit": true,
|
|
|
|
|
"SwapLimit": false,
|
|
|
|
|
"IPv4Forwarding": true
|
2014-05-16 11:47:33 +00:00
|
|
|
|
}
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
Status Codes:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
- **200** – no error
|
|
|
|
|
- **500** – server error
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
### Show the docker version information
|
|
|
|
|
|
|
|
|
|
`GET /version`
|
|
|
|
|
|
|
|
|
|
Show the docker version information
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
**Example request**:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
GET /version HTTP/1.1
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
**Example response**:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
HTTP/1.1 200 OK
|
|
|
|
|
Content-Type: application/json
|
|
|
|
|
|
|
|
|
|
{
|
2015-01-05 10:45:10 +00:00
|
|
|
|
"ApiVersion": "1.12",
|
|
|
|
|
"Version": "0.2.2",
|
|
|
|
|
"GitCommit": "5a2a5cc+CHANGES",
|
|
|
|
|
"GoVersion": "go1.0.3"
|
2014-05-16 11:47:33 +00:00
|
|
|
|
}
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
Status Codes:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
- **200** – no error
|
|
|
|
|
- **500** – server error
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
### Ping the docker server
|
|
|
|
|
|
|
|
|
|
`GET /_ping`
|
|
|
|
|
|
|
|
|
|
Ping the docker server
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
**Example request**:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
GET /_ping HTTP/1.1
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
**Example response**:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
HTTP/1.1 200 OK
|
2014-09-22 00:05:58 +00:00
|
|
|
|
Content-Type: text/plain
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
OK
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
Status Codes:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
- **200** - no error
|
|
|
|
|
- **500** - server error
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
### Create a new image from a container's changes
|
|
|
|
|
|
|
|
|
|
`POST /commit`
|
|
|
|
|
|
|
|
|
|
Create a new image from a container's changes
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
**Example request**:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-10-16 10:08:15 +00:00
|
|
|
|
POST /commit?container=44c004db4b17&comment=message&repo=myrepo HTTP/1.1
|
2014-05-16 11:47:33 +00:00
|
|
|
|
Content-Type: application/json
|
|
|
|
|
|
|
|
|
|
{
|
2015-01-05 10:45:10 +00:00
|
|
|
|
"Hostname": "",
|
2014-09-01 18:41:42 +00:00
|
|
|
|
"Domainname": "",
|
2015-01-05 10:45:10 +00:00
|
|
|
|
"User": "",
|
|
|
|
|
"Memory": 0,
|
|
|
|
|
"MemorySwap": 0,
|
2014-09-01 18:41:42 +00:00
|
|
|
|
"CpuShares": 512,
|
|
|
|
|
"Cpuset": "0,1",
|
2015-01-05 10:45:10 +00:00
|
|
|
|
"AttachStdin": false,
|
|
|
|
|
"AttachStdout": true,
|
|
|
|
|
"AttachStderr": true,
|
|
|
|
|
"PortSpecs": null,
|
|
|
|
|
"Tty": false,
|
|
|
|
|
"OpenStdin": false,
|
|
|
|
|
"StdinOnce": false,
|
|
|
|
|
"Env": null,
|
|
|
|
|
"Cmd": [
|
2014-05-16 11:47:33 +00:00
|
|
|
|
"date"
|
|
|
|
|
],
|
2015-01-05 10:45:10 +00:00
|
|
|
|
"Volumes": {
|
2014-05-16 11:47:33 +00:00
|
|
|
|
"/tmp": {}
|
|
|
|
|
},
|
2015-01-05 10:45:10 +00:00
|
|
|
|
"WorkingDir": "",
|
2014-09-01 18:41:42 +00:00
|
|
|
|
"NetworkDisabled": false,
|
2015-01-05 10:45:10 +00:00
|
|
|
|
"ExposedPorts": {
|
2014-05-16 11:47:33 +00:00
|
|
|
|
"22/tcp": {}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
**Example response**:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-22 00:05:58 +00:00
|
|
|
|
HTTP/1.1 201 Created
|
|
|
|
|
Content-Type: application/vnd.docker.raw-stream
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2015-01-05 10:45:10 +00:00
|
|
|
|
{"Id": "596069db4bf5"}
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
Json Parameters:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
- **config** - the container's configuration
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
Query Parameters:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
- **container** – source container
|
|
|
|
|
- **repo** – repository
|
|
|
|
|
- **tag** – tag
|
2014-10-16 10:08:15 +00:00
|
|
|
|
- **comment** – commit message
|
2014-09-09 05:00:23 +00:00
|
|
|
|
- **author** – author (e.g., "John Hannibal Smith
|
2014-09-22 00:05:58 +00:00
|
|
|
|
<[hannibal@a-team.com](mailto:hannibal%40a-team.com)>")
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
Status Codes:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
- **201** – no error
|
|
|
|
|
- **404** – no such container
|
|
|
|
|
- **500** – server error
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
### Monitor Docker's events
|
|
|
|
|
|
|
|
|
|
`GET /events`
|
|
|
|
|
|
The list of events that 'grep' told me about
docker(master) $ git grep 'LogEvent("' | sed 's/.*("//' | sed 's/").*//'
| sort | uniq | paste -s -d","
create,destroy,die,export,kill,pause,restart,start,stop,unpause
Docker-DCO-1.1-Signed-off-by: SvenDowideit <SvenDowideit@home.org.au> (github: SvenDowideit)
2014-09-25 05:32:51 +00:00
|
|
|
|
Get container events from docker, either in real time via streaming, or via
|
|
|
|
|
polling (using since).
|
|
|
|
|
|
|
|
|
|
Docker containers will report the following events:
|
|
|
|
|
|
|
|
|
|
create, destroy, die, export, kill, pause, restart, start, stop, unpause
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-26 01:55:36 +00:00
|
|
|
|
and Docker images will report:
|
|
|
|
|
|
|
|
|
|
untag, delete
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
**Example request**:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
GET /events?since=1374067924
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
**Example response**:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
HTTP/1.1 200 OK
|
|
|
|
|
Content-Type: application/json
|
|
|
|
|
|
2015-01-16 13:04:24 +00:00
|
|
|
|
{"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}
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
Query Parameters:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
- **since** – timestamp used for polling
|
|
|
|
|
- **until** – timestamp used for polling
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
Status Codes:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
- **200** – no error
|
|
|
|
|
- **500** – server error
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
### Get a tarball containing all images and tags in a repository
|
|
|
|
|
|
|
|
|
|
`GET /images/(name)/get`
|
|
|
|
|
|
|
|
|
|
Get a tarball containing all images and metadata for the repository
|
|
|
|
|
specified by `name`.
|
|
|
|
|
|
2014-09-16 06:43:08 +00:00
|
|
|
|
See the [image tarball format](#image-tarball-format) for more details.
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
**Example request**
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-16 05:25:52 +00:00
|
|
|
|
GET /images/ubuntu/get
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
**Example response**:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
HTTP/1.1 200 OK
|
|
|
|
|
Content-Type: application/x-tar
|
|
|
|
|
|
|
|
|
|
Binary data stream
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
Status Codes:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
- **200** – no error
|
|
|
|
|
- **500** – server error
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
### Load a tarball with a set of images and tags into docker
|
|
|
|
|
|
|
|
|
|
`POST /images/load`
|
|
|
|
|
|
|
|
|
|
Load a set of images and tags into the docker repository.
|
2014-09-16 06:43:08 +00:00
|
|
|
|
See the [image tarball format](#image-tarball-format) for more details.
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
**Example request**
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
POST /images/load
|
|
|
|
|
|
|
|
|
|
Tarball in body
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
**Example response**:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
HTTP/1.1 200 OK
|
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
Status Codes:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-09 05:00:23 +00:00
|
|
|
|
- **200** – no error
|
|
|
|
|
- **500** – server error
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-09-16 06:43:08 +00:00
|
|
|
|
### Image tarball format
|
|
|
|
|
|
|
|
|
|
An image tarball contains one directory per image layer (named using its long ID),
|
|
|
|
|
each containing three files:
|
|
|
|
|
|
|
|
|
|
1. `VERSION`: currently `1.0` - the file format version
|
|
|
|
|
2. `json`: detailed layer information, similar to `docker inspect layer_id`
|
|
|
|
|
3. `layer.tar`: A tarfile containing the filesystem changes in this layer
|
|
|
|
|
|
|
|
|
|
The `layer.tar` file will contain `aufs` style `.wh..wh.aufs` files and directories
|
|
|
|
|
for storing attribute changes and deletions.
|
|
|
|
|
|
|
|
|
|
If the tarball defines a repository, there will also be a `repositories` file at
|
|
|
|
|
the root that contains a list of repository and tag names mapped to layer IDs.
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
{"hello-world":
|
2015-01-05 10:45:10 +00:00
|
|
|
|
{"latest": "565a9d68a73f6706862bfe8409a7f659776d4d60a8d096eb4a3cbce6999cc2a1"}
|
2014-09-16 06:43:08 +00:00
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
2014-05-16 11:47:33 +00:00
|
|
|
|
# 3. Going further
|
|
|
|
|
|
|
|
|
|
## 3.1 Inside `docker run`
|
|
|
|
|
|
2014-09-22 00:05:58 +00:00
|
|
|
|
As an example, the `docker run` command line makes the following API calls:
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
- Create the container
|
|
|
|
|
|
2014-09-22 00:05:58 +00:00
|
|
|
|
- If the status code is 404, it means the image doesn't exist:
|
|
|
|
|
- Try to pull it
|
|
|
|
|
- Then retry to create the container
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
- Start the container
|
|
|
|
|
|
|
|
|
|
- If you are not in detached mode:
|
2014-09-22 00:05:58 +00:00
|
|
|
|
- Attach to the container, using logs=1 (to have stdout and
|
2014-05-16 11:47:33 +00:00
|
|
|
|
stderr from the container's start) and stream=1
|
|
|
|
|
|
|
|
|
|
- If in detached mode or only stdin is attached:
|
2014-09-22 00:05:58 +00:00
|
|
|
|
- Display the container's id
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
|
|
|
|
## 3.2 Hijacking
|
|
|
|
|
|
|
|
|
|
In this version of the API, /attach, uses hijacking to transport stdin,
|
|
|
|
|
stdout and stderr on the same socket. This might change in the future.
|
|
|
|
|
|
|
|
|
|
## 3.3 CORS Requests
|
|
|
|
|
|
|
|
|
|
To enable cross origin requests to the remote api add the flag
|
2014-09-22 00:05:58 +00:00
|
|
|
|
"--api-enable-cors" when running docker in daemon mode.
|
2014-05-16 11:47:33 +00:00
|
|
|
|
|
2014-06-03 19:44:20 +00:00
|
|
|
|
$ docker -d -H="192.168.1.9:2375" --api-enable-cors
|