Signed-off-by: Mary Anthony <mary@docker.com>
(cherry picked from commit 5ce093e94565a5f32df9adf78dcdb6deeda75f79)
Conflicts:
docs/reference/api/docker_remote_api.md
docs/reference/api/docker_remote_api_v1.21.md
docs/reference/api/docker_remote_api_v1.22.md
... | ... |
@@ -5,19 +5,20 @@ description = "API Documentation for Docker" |
5 | 5 |
keywords = ["API, Docker, rcli, REST, documentation"] |
6 | 6 |
[menu.main] |
7 | 7 |
parent = "smn_remoteapi" |
8 |
+weight=-3 |
|
8 | 9 |
+++ |
9 | 10 |
<![end-metadata]--> |
10 | 11 |
|
11 | 12 |
# Docker Remote API |
12 | 13 |
|
13 |
-Docker's Remote API uses an open schema model. In this model, unknown |
|
14 |
+Docker's Remote API uses an open schema model. In this model, unknown |
|
14 | 15 |
properties in incoming messages are ignored. Client applications need to take |
15 | 16 |
this behavior into account to ensure they do not break when talking to newer |
16 | 17 |
Docker daemons. |
17 | 18 |
|
18 | 19 |
The API tends to be REST, but for some complex commands, like attach or pull, |
19 | 20 |
the HTTP connection is hijacked to transport STDOUT, STDIN, and STDERR. |
20 |
- |
|
21 |
+ |
|
21 | 22 |
By default the Docker daemon listens on `unix:///var/run/docker.sock` and the |
22 | 23 |
client must have `root` access to interact with the daemon. If a group named |
23 | 24 |
`docker` exists on your system, `docker` applies ownership of the socket to the |
... | ... |
@@ -31,14 +32,14 @@ Use the table below to find the API version for a Docker version: |
31 | 31 |
|
32 | 32 |
Docker version | API version | Changes |
33 | 33 |
----------------|-------------------------------------------------|----------------------------- |
34 |
-1.9.x | [1.21](/reference/api/docker_remote_api_v1.21/) | [API changes](/reference/api/docker_remote_api/#v1-21-api-changes) |
|
35 |
-1.8.x | [1.20](/reference/api/docker_remote_api_v1.20/) | [API changes](/reference/api/docker_remote_api/#v1-20-api-changes) |
|
36 |
-1.7.x | [1.19](/reference/api/docker_remote_api_v1.19/) | [API changes](/reference/api/docker_remote_api/#v1-19-api-changes) |
|
37 |
-1.6.x | [1.18](/reference/api/docker_remote_api_v1.18/) | [API changes](/reference/api/docker_remote_api/#v1-18-api-changes) |
|
38 |
-1.5.x | [1.17](/reference/api/docker_remote_api_v1.17/) | [API changes](/reference/api/docker_remote_api/#v1-17-api-changes) |
|
39 |
-1.4.x | [1.16](/reference/api/docker_remote_api_v1.16/) | [API changes](/reference/api/docker_remote_api/#v1-16-api-changes) |
|
40 |
-1.3.x | [1.15](/reference/api/docker_remote_api_v1.15/) | [API changes](/reference/api/docker_remote_api/#v1-15-api-changes) |
|
41 |
-1.2.x | [1.14](/reference/api/docker_remote_api_v1.14/) | [API changes](/reference/api/docker_remote_api/#v1-14-api-changes) |
|
34 |
+1.9.x | [1.21](docker_remote_api_v1.21.md) | [API changes](docker_remote_api.md#v1-21-api-changes) |
|
35 |
+1.8.x | [1.20](docker_remote_api_v1.20.md) | [API changes](docker_remote_api.md#v1-20-api-changes) |
|
36 |
+1.7.x | [1.19](docker_remote_api_v1.19.md) | [API changes](docker_remote_api.md#v1-19-api-changes) |
|
37 |
+1.6.x | [1.18](docker_remote_api_v1.18.md) | [API changes](docker_remote_api.md#v1-18-api-changes) |
|
38 |
+1.5.x | [1.17](docker_remote_api_v1.17.md) | [API changes](docker_remote_api.md#v1-17-api-changes) |
|
39 |
+1.4.x | [1.16](docker_remote_api_v1.16.md) | [API changes](docker_remote_api.md#v1-16-api-changes) |
|
40 |
+1.3.x | [1.15](docker_remote_api_v1.15.md) | [API changes](docker_remote_api.md#v1-15-api-changes) |
|
41 |
+1.2.x | [1.14](docker_remote_api_v1.14.md) | [API changes](docker_remote_api.md#v1-14-api-changes) |
|
42 | 42 |
|
43 | 43 |
Refer to the [GitHub repository]( |
44 | 44 |
https://github.com/docker/docker/tree/master/docs/reference/api) for |
... | ... |
@@ -55,7 +56,7 @@ client has to send the `authConfig` as a `POST` in `/images/(name)/push`. The |
55 | 55 |
{"username": "string", "password": "string", "email": "string", |
56 | 56 |
"serveraddress" : "string", "auth": ""} |
57 | 57 |
``` |
58 |
- |
|
58 |
+ |
|
59 | 59 |
Callers should leave the `auth` empty. The `serveraddress` is a domain/ip |
60 | 60 |
without protocol. Throughout this structure, double quotes are required. |
61 | 61 |
|
... | ... |
@@ -166,7 +167,7 @@ example you could add data describing the content of an image. `LABEL |
166 | 166 |
* `GET /containers/(id)/json` returns the list current execs associated with the |
167 | 167 |
container (`ExecIDs`). This endpoint now returns the container labels |
168 | 168 |
(`Config.Labels`). |
169 |
-* `POST /containers/(id)/rename` renames a container `id` to a new name.* |
|
169 |
+* `POST /containers/(id)/rename` renames a container `id` to a new name.* |
|
170 | 170 |
* `POST /containers/create` and `POST /containers/(id)/start` callers can pass |
171 | 171 |
`ReadonlyRootfs` in the host config to mount the container's root filesystem as |
172 | 172 |
read only. |
... | ... |
@@ -5,7 +5,7 @@ description = "API Documentation for Docker" |
5 | 5 |
keywords = ["API, Docker, rcli, REST, documentation"] |
6 | 6 |
[menu.main] |
7 | 7 |
parent="smn_remoteapi" |
8 |
-weight = 0 |
|
8 |
+weight=-2 |
|
9 | 9 |
+++ |
10 | 10 |
<![end-metadata]--> |
11 | 11 |
|
... | ... |
@@ -1403,8 +1403,8 @@ Query Parameters: |
1403 | 1403 |
ignored if `remote` is specified and points to an individual filename. |
1404 | 1404 |
- **t** – A repository name (and optionally a tag) to apply to |
1405 | 1405 |
the resulting image in case of success. |
1406 |
-- **remote** – A Git repository URI or HTTP/HTTPS URI build source. If the |
|
1407 |
- URI specifies a filename, the file's contents are placed into a file |
|
1406 |
+- **remote** – A Git repository URI or HTTP/HTTPS URI build source. If the |
|
1407 |
+ URI specifies a filename, the file's contents are placed into a file |
|
1408 | 1408 |
called `Dockerfile`. |
1409 | 1409 |
- **q** – Suppress verbose build output. |
1410 | 1410 |
- **nocache** – Do not use the cache when building the image. |
... | ... |
@@ -2800,7 +2800,7 @@ from **200 OK** to **101 UPGRADED** and resends the same headers. |
2800 | 2800 |
|
2801 | 2801 |
## 3.3 CORS Requests |
2802 | 2802 |
|
2803 |
-To set cross origin requests to the remote api please give values to |
|
2803 |
+To set cross origin requests to the remote api please give values to |
|
2804 | 2804 |
`--api-cors-header` when running Docker in daemon mode. Set * (asterisk) allows all, |
2805 | 2805 |
default or blank means CORS disabled |
2806 | 2806 |
|