Signed-off-by: Mary Anthony <mary@docker.com>
| ... | ... |
@@ -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,15 +32,15 @@ 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.10.x | [1.22](/reference/api/docker_remote_api_v1.22/) | [API changes](/reference/api/docker_remote_api/#v1-22-api-changes) |
|
| 35 |
-1.9.x | [1.21](/reference/api/docker_remote_api_v1.21/) | [API changes](/reference/api/docker_remote_api/#v1-21-api-changes) |
|
| 36 |
-1.8.x | [1.20](/reference/api/docker_remote_api_v1.20/) | [API changes](/reference/api/docker_remote_api/#v1-20-api-changes) |
|
| 37 |
-1.7.x | [1.19](/reference/api/docker_remote_api_v1.19/) | [API changes](/reference/api/docker_remote_api/#v1-19-api-changes) |
|
| 38 |
-1.6.x | [1.18](/reference/api/docker_remote_api_v1.18/) | [API changes](/reference/api/docker_remote_api/#v1-18-api-changes) |
|
| 39 |
-1.5.x | [1.17](/reference/api/docker_remote_api_v1.17/) | [API changes](/reference/api/docker_remote_api/#v1-17-api-changes) |
|
| 40 |
-1.4.x | [1.16](/reference/api/docker_remote_api_v1.16/) | [API changes](/reference/api/docker_remote_api/#v1-16-api-changes) |
|
| 41 |
-1.3.x | [1.15](/reference/api/docker_remote_api_v1.15/) | [API changes](/reference/api/docker_remote_api/#v1-15-api-changes) |
|
| 42 |
-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.10.x | [1.22](docker_remote_api_v1.22.md) | [API changes](docker_remote_api.md#v1-22-api-changes) |
|
| 35 |
+1.9.x | [1.21](docker_remote_api_v1.21.md) | [API changes](docker_remote_api.md#v1-21-api-changes) |
|
| 36 |
+1.8.x | [1.20](docker_remote_api_v1.20.md) | [API changes](docker_remote_api.md#v1-20-api-changes) |
|
| 37 |
+1.7.x | [1.19](docker_remote_api_v1.19.md) | [API changes](docker_remote_api.md#v1-19-api-changes) |
|
| 38 |
+1.6.x | [1.18](docker_remote_api_v1.18.md) | [API changes](docker_remote_api.md#v1-18-api-changes) |
|
| 39 |
+1.5.x | [1.17](docker_remote_api_v1.17.md) | [API changes](docker_remote_api.md#v1-17-api-changes) |
|
| 40 |
+1.4.x | [1.16](docker_remote_api_v1.16.md) | [API changes](docker_remote_api.md#v1-16-api-changes) |
|
| 41 |
+1.3.x | [1.15](docker_remote_api_v1.15.md) | [API changes](docker_remote_api.md#v1-15-api-changes) |
|
| 42 |
+1.2.x | [1.14](docker_remote_api_v1.14.md) | [API changes](docker_remote_api.md#v1-14-api-changes) |
|
| 43 | 43 |
|
| 44 | 44 |
Refer to the [GitHub repository]( |
| 45 | 45 |
https://github.com/docker/docker/tree/master/docs/reference/api) for |
| ... | ... |
@@ -56,7 +57,7 @@ client has to send the `authConfig` as a `POST` in `/images/(name)/push`. The |
| 56 | 56 |
{"username": "string", "password": "string", "email": "string",
|
| 57 | 57 |
"serveraddress" : "string", "auth": ""} |
| 58 | 58 |
``` |
| 59 |
- |
|
| 59 |
+ |
|
| 60 | 60 |
Callers should leave the `auth` empty. The `serveraddress` is a domain/ip |
| 61 | 61 |
without protocol. Throughout this structure, double quotes are required. |
| 62 | 62 |
|
| ... | ... |
@@ -172,7 +173,7 @@ example you could add data describing the content of an image. `LABEL |
| 172 | 172 |
* `GET /containers/(id)/json` returns the list current execs associated with the |
| 173 | 173 |
container (`ExecIDs`). This endpoint now returns the container labels |
| 174 | 174 |
(`Config.Labels`). |
| 175 |
-* `POST /containers/(id)/rename` renames a container `id` to a new name.* |
|
| 175 |
+* `POST /containers/(id)/rename` renames a container `id` to a new name.* |
|
| 176 | 176 |
* `POST /containers/create` and `POST /containers/(id)/start` callers can pass |
| 177 | 177 |
`ReadonlyRootfs` in the host config to mount the container's root filesystem as |
| 178 | 178 |
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 |
|
| ... | ... |
@@ -1406,8 +1406,8 @@ Query Parameters: |
| 1406 | 1406 |
- **t** – A name and optional tag to apply to the image in the `name:tag` format. |
| 1407 | 1407 |
If you omit the `tag` the default `latest` value is assumed. |
| 1408 | 1408 |
You can provide one or more `t` parameters. |
| 1409 |
-- **remote** – A Git repository URI or HTTP/HTTPS URI build source. If the |
|
| 1410 |
- URI specifies a filename, the file's contents are placed into a file |
|
| 1409 |
+- **remote** – A Git repository URI or HTTP/HTTPS URI build source. If the |
|
| 1410 |
+ URI specifies a filename, the file's contents are placed into a file |
|
| 1411 | 1411 |
called `Dockerfile`. |
| 1412 | 1412 |
- **q** – Suppress verbose build output. |
| 1413 | 1413 |
- **nocache** – Do not use the cache when building the image. |
| ... | ... |
@@ -2803,7 +2803,7 @@ from **200 OK** to **101 UPGRADED** and resends the same headers. |
| 2803 | 2803 |
|
| 2804 | 2804 |
## 3.3 CORS Requests |
| 2805 | 2805 |
|
| 2806 |
-To set cross origin requests to the remote api please give values to |
|
| 2806 |
+To set cross origin requests to the remote api please give values to |
|
| 2807 | 2807 |
`--api-cors-header` when running Docker in daemon mode. Set * (asterisk) allows all, |
| 2808 | 2808 |
default or blank means CORS disabled |
| 2809 | 2809 |
|
| ... | ... |
@@ -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=-3 |
|
| 9 | 9 |
+++ |
| 10 | 10 |
<![end-metadata]--> |
| 11 | 11 |
|
| ... | ... |
@@ -1404,8 +1404,8 @@ Query Parameters: |
| 1404 | 1404 |
- **t** – A name and optional tag to apply to the image in the `name:tag` format. |
| 1405 | 1405 |
If you omit the `tag` the default `latest` value is assumed. |
| 1406 | 1406 |
You can provide one or more `t` parameters. |
| 1407 |
-- **remote** – A Git repository URI or HTTP/HTTPS URI build source. If the |
|
| 1408 |
- URI specifies a filename, the file's contents are placed into a file |
|
| 1407 |
+- **remote** – A Git repository URI or HTTP/HTTPS URI build source. If the |
|
| 1408 |
+ URI specifies a filename, the file's contents are placed into a file |
|
| 1409 | 1409 |
called `Dockerfile`. |
| 1410 | 1410 |
- **q** – Suppress verbose build output. |
| 1411 | 1411 |
- **nocache** – Do not use the cache when building the image. |
| ... | ... |
@@ -2798,7 +2798,7 @@ from **200 OK** to **101 UPGRADED** and resends the same headers. |
| 2798 | 2798 |
|
| 2799 | 2799 |
## 3.3 CORS Requests |
| 2800 | 2800 |
|
| 2801 |
-To set cross origin requests to the remote api please give values to |
|
| 2801 |
+To set cross origin requests to the remote api please give values to |
|
| 2802 | 2802 |
`--api-cors-header` when running Docker in daemon mode. Set * (asterisk) allows all, |
| 2803 | 2803 |
default or blank means CORS disabled |
| 2804 | 2804 |
|