kotovalexarian-likes-github/moby--moby
1
0
Fork 0
mirror of https://github.com/moby/moby.git synced 2022-11-09 12:21:53 -05:00
Code Releases Activity

Fixing broken links

Browse source 
Fixing the weight

Signed-off-by: Mary Anthony <mary@docker.com>
This commit is contained in:
Mary Anthony 2015-10-31 19:27:21 -07:00
parent 4468e1e74e
commit 5ce093e945
3 changed files with 22 additions and 21 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
docs/reference/api/docker_remote_api.md
View file

@ -5,19 +5,20 @@ description = "API Documentation for Docker"
keywords = ["API, Docker, rcli, REST, documentation"] keywords = ["API, Docker, rcli, REST, documentation"]
[menu.main] [menu.main]
parent = "smn_remoteapi" parent = "smn_remoteapi"
weight=-3
+++ +++
<![end-metadata]--> <![end-metadata]-->
# Docker Remote API # Docker Remote API
Docker's Remote API uses an open schema model. In this model, unknown Docker's Remote API uses an open schema model. In this model, unknown
properties in incoming messages are ignored. Client applications need to take properties in incoming messages are ignored. Client applications need to take
this behavior into account to ensure they do not break when talking to newer this behavior into account to ensure they do not break when talking to newer
Docker daemons. Docker daemons.
The API tends to be REST, but for some complex commands, like attach or pull, The API tends to be REST, but for some complex commands, like attach or pull,
the HTTP connection is hijacked to transport STDOUT, STDIN, and STDERR. the HTTP connection is hijacked to transport STDOUT, STDIN, and STDERR.
By default the Docker daemon listens on `unix:///var/run/docker.sock` and the By default the Docker daemon listens on `unix:///var/run/docker.sock` and the
client must have `root` access to interact with the daemon. If a group named client must have `root` access to interact with the daemon. If a group named
`docker` exists on your system, `docker` applies ownership of the socket to the `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:
Docker version | API version | Changes Docker version | API version | Changes
----------------|-------------------------------------------------|----------------------------- ----------------|-------------------------------------------------|-----------------------------
1.10.x | [1.22](/reference/api/docker_remote_api_v1.22/) | [API changes](/reference/api/docker_remote_api/#v1-22-api-changes) 1.10.x | [1.22](docker_remote_api_v1.22.md) | [API changes](docker_remote_api.md#v1-22-api-changes)
1.9.x | [1.21](/reference/api/docker_remote_api_v1.21/) | [API changes](/reference/api/docker_remote_api/#v1-21-api-changes) 1.9.x | [1.21](docker_remote_api_v1.21.md) | [API changes](docker_remote_api.md#v1-21-api-changes)
1.8.x | [1.20](/reference/api/docker_remote_api_v1.20/) | [API changes](/reference/api/docker_remote_api/#v1-20-api-changes) 1.8.x | [1.20](docker_remote_api_v1.20.md) | [API changes](docker_remote_api.md#v1-20-api-changes)
1.7.x | [1.19](/reference/api/docker_remote_api_v1.19/) | [API changes](/reference/api/docker_remote_api/#v1-19-api-changes) 1.7.x | [1.19](docker_remote_api_v1.19.md) | [API changes](docker_remote_api.md#v1-19-api-changes)
1.6.x | [1.18](/reference/api/docker_remote_api_v1.18/) | [API changes](/reference/api/docker_remote_api/#v1-18-api-changes) 1.6.x | [1.18](docker_remote_api_v1.18.md) | [API changes](docker_remote_api.md#v1-18-api-changes)
1.5.x | [1.17](/reference/api/docker_remote_api_v1.17/) | [API changes](/reference/api/docker_remote_api/#v1-17-api-changes) 1.5.x | [1.17](docker_remote_api_v1.17.md) | [API changes](docker_remote_api.md#v1-17-api-changes)
1.4.x | [1.16](/reference/api/docker_remote_api_v1.16/) | [API changes](/reference/api/docker_remote_api/#v1-16-api-changes) 1.4.x | [1.16](docker_remote_api_v1.16.md) | [API changes](docker_remote_api.md#v1-16-api-changes)
1.3.x | [1.15](/reference/api/docker_remote_api_v1.15/) | [API changes](/reference/api/docker_remote_api/#v1-15-api-changes) 1.3.x | [1.15](docker_remote_api_v1.15.md) | [API changes](docker_remote_api.md#v1-15-api-changes)
1.2.x | [1.14](/reference/api/docker_remote_api_v1.14/) | [API changes](/reference/api/docker_remote_api/#v1-14-api-changes) 1.2.x | [1.14](docker_remote_api_v1.14.md) | [API changes](docker_remote_api.md#v1-14-api-changes)
Refer to the [GitHub repository]( Refer to the [GitHub repository](
https://github.com/docker/docker/tree/master/docs/reference/api) for 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
{"username": "string", "password": "string", "email": "string", {"username": "string", "password": "string", "email": "string",
"serveraddress" : "string", "auth": ""} "serveraddress" : "string", "auth": ""}
``` ```
Callers should leave the `auth` empty. The `serveraddress` is a domain/ip Callers should leave the `auth` empty. The `serveraddress` is a domain/ip
without protocol. Throughout this structure, double quotes are required. without protocol. Throughout this structure, double quotes are required.
@ -172,7 +173,7 @@ example you could add data describing the content of an image. `LABEL
* `GET /containers/(id)/json` returns the list current execs associated with the * `GET /containers/(id)/json` returns the list current execs associated with the
container (`ExecIDs`). This endpoint now returns the container labels container (`ExecIDs`). This endpoint now returns the container labels
(`Config.Labels`). (`Config.Labels`).
* `POST /containers/(id)/rename` renames a container `id` to a new name.* * `POST /containers/(id)/rename` renames a container `id` to a new name.*
* `POST /containers/create` and `POST /containers/(id)/start` callers can pass * `POST /containers/create` and `POST /containers/(id)/start` callers can pass
`ReadonlyRootfs` in the host config to mount the container's root filesystem as `ReadonlyRootfs` in the host config to mount the container's root filesystem as
read only. read only.

8
docs/reference/api/docker_remote_api_v1.21.md
View file

@ -5,7 +5,7 @@ description = "API Documentation for Docker"
keywords = ["API, Docker, rcli, REST, documentation"] keywords = ["API, Docker, rcli, REST, documentation"]
[menu.main] [menu.main]
parent="smn_remoteapi" parent="smn_remoteapi"
weight = 0 weight=-2
+++ +++
<![end-metadata]--> <![end-metadata]-->
@ -1406,8 +1406,8 @@ Query Parameters:
- **t** – A name and optional tag to apply to the image in the `name:tag` format. - **t** – A name and optional tag to apply to the image in the `name:tag` format.
If you omit the `tag` the default `latest` value is assumed. If you omit the `tag` the default `latest` value is assumed.
You can provide one or more `t` parameters. You can provide one or more `t` parameters.
- **remote** – A Git repository URI or HTTP/HTTPS URI build source. If the - **remote** – A Git repository URI or HTTP/HTTPS URI build source. If the
URI specifies a filename, the file's contents are placed into a file URI specifies a filename, the file's contents are placed into a file
called `Dockerfile`. called `Dockerfile`.
- **q** – Suppress verbose build output. - **q** – Suppress verbose build output.
- **nocache** – Do not use the cache when building the image. - **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.
## 3.3 CORS Requests ## 3.3 CORS Requests
To set cross origin requests to the remote api please give values to 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, `--api-cors-header` when running Docker in daemon mode. Set * (asterisk) allows all,
default or blank means CORS disabled default or blank means CORS disabled

8
docs/reference/api/docker_remote_api_v1.22.md
View file

@ -5,7 +5,7 @@ description = "API Documentation for Docker"
keywords = ["API, Docker, rcli, REST, documentation"] keywords = ["API, Docker, rcli, REST, documentation"]
[menu.main] [menu.main]
parent="smn_remoteapi" parent="smn_remoteapi"
weight = 0 weight=-3
+++ +++
<![end-metadata]--> <![end-metadata]-->
@ -1404,8 +1404,8 @@ Query Parameters:
- **t** – A name and optional tag to apply to the image in the `name:tag` format. - **t** – A name and optional tag to apply to the image in the `name:tag` format.
If you omit the `tag` the default `latest` value is assumed. If you omit the `tag` the default `latest` value is assumed.
You can provide one or more `t` parameters. You can provide one or more `t` parameters.
- **remote** – A Git repository URI or HTTP/HTTPS URI build source. If the - **remote** – A Git repository URI or HTTP/HTTPS URI build source. If the
URI specifies a filename, the file's contents are placed into a file URI specifies a filename, the file's contents are placed into a file
called `Dockerfile`. called `Dockerfile`.
- **q** – Suppress verbose build output. - **q** – Suppress verbose build output.
- **nocache** – Do not use the cache when building the image. - **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.
## 3.3 CORS Requests ## 3.3 CORS Requests
To set cross origin requests to the remote api please give values to 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, `--api-cors-header` when running Docker in daemon mode. Set * (asterisk) allows all,
default or blank means CORS disabled default or blank means CORS disabled