diff --git a/docs/reference/api/docker_remote_api_v1.14.md b/docs/reference/api/docker_remote_api_v1.14.md index a3008073e1..8aa7871c30 100644 --- a/docs/reference/api/docker_remote_api_v1.14.md +++ b/docs/reference/api/docker_remote_api_v1.14.md @@ -429,7 +429,7 @@ Start the container `id` **Example request**: - POST /containers/(id or name)/start HTTP/1.1 + POST /containers/e90e34656806/start HTTP/1.1 Content-Type: application/json { diff --git a/docs/reference/api/docker_remote_api_v1.15.md b/docs/reference/api/docker_remote_api_v1.15.md index 3987f47dfe..428fc7185e 100644 --- a/docs/reference/api/docker_remote_api_v1.15.md +++ b/docs/reference/api/docker_remote_api_v1.15.md @@ -538,7 +538,7 @@ Start the container `id` **Example request**: - POST /containers/(id or name)/start HTTP/1.1 + POST /containers/e90e34656806/start HTTP/1.1 Content-Type: application/json { diff --git a/docs/reference/api/docker_remote_api_v1.16.md b/docs/reference/api/docker_remote_api_v1.16.md index 1d7dc4d40f..675a93c010 100644 --- a/docs/reference/api/docker_remote_api_v1.16.md +++ b/docs/reference/api/docker_remote_api_v1.16.md @@ -542,7 +542,7 @@ Start the container `id` **Example request**: - POST /containers/(id or name)/start HTTP/1.1 + POST /containers/e90e34656806/start HTTP/1.1 **Example response**: diff --git a/docs/reference/api/docker_remote_api_v1.17.md b/docs/reference/api/docker_remote_api_v1.17.md index 7047119879..1fb12e8c82 100644 --- a/docs/reference/api/docker_remote_api_v1.17.md +++ b/docs/reference/api/docker_remote_api_v1.17.md @@ -672,7 +672,7 @@ Start the container `id` **Example request**: - POST /containers/(id or name)/start HTTP/1.1 + POST /containers/e90e34656806/start HTTP/1.1 **Example response**: diff --git a/docs/reference/api/docker_remote_api_v1.18.md b/docs/reference/api/docker_remote_api_v1.18.md index c336cb7327..6ef3a59d1f 100644 --- a/docs/reference/api/docker_remote_api_v1.18.md +++ b/docs/reference/api/docker_remote_api_v1.18.md @@ -719,7 +719,7 @@ Start the container `id` **Example request**: - POST /containers/(id or name)/start HTTP/1.1 + POST /containers/e90e34656806/start HTTP/1.1 **Example response**: diff --git a/docs/reference/api/docker_remote_api_v1.19.md b/docs/reference/api/docker_remote_api_v1.19.md index 94dab0f080..4af832e4bb 100644 --- a/docs/reference/api/docker_remote_api_v1.19.md +++ b/docs/reference/api/docker_remote_api_v1.19.md @@ -740,7 +740,7 @@ Start the container `id` **Example request**: - POST /containers/(id or name)/start HTTP/1.1 + POST /containers/e90e34656806/start HTTP/1.1 **Example response**: diff --git a/docs/reference/api/docker_remote_api_v1.20.md b/docs/reference/api/docker_remote_api_v1.20.md index 82521867e4..c1a06fff5e 100644 --- a/docs/reference/api/docker_remote_api_v1.20.md +++ b/docs/reference/api/docker_remote_api_v1.20.md @@ -753,7 +753,7 @@ Start the container `id` **Example request**: - POST /containers/(id or name)/start HTTP/1.1 + POST /containers/e90e34656806/start HTTP/1.1 **Example response**: diff --git a/docs/reference/api/docker_remote_api_v1.21.md b/docs/reference/api/docker_remote_api_v1.21.md index 9afab7dc21..68349e5d49 100644 --- a/docs/reference/api/docker_remote_api_v1.21.md +++ b/docs/reference/api/docker_remote_api_v1.21.md @@ -836,7 +836,7 @@ Start the container `id` **Example request**: - POST /containers/(id or name)/start HTTP/1.1 + POST /containers/e90e34656806/start HTTP/1.1 **Example response**: diff --git a/docs/reference/api/docker_remote_api_v1.22.md b/docs/reference/api/docker_remote_api_v1.22.md index 27b90f3f01..7082cd7470 100644 --- a/docs/reference/api/docker_remote_api_v1.22.md +++ b/docs/reference/api/docker_remote_api_v1.22.md @@ -418,7 +418,7 @@ Status Codes: ### Inspect a container -`GET /containers/(id)/json` +`GET /containers/(id or name)/json` Return low-level information on the container `id` @@ -620,7 +620,7 @@ Status Codes: ### List processes running inside a container -`GET /containers/(id)/top` +`GET /containers/(id or name)/top` List processes running inside the container `id`. On Unix systems this is done by running the `ps` command. This endpoint is not @@ -684,7 +684,7 @@ Status Codes: ### Get container logs -`GET /containers/(id)/logs` +`GET /containers/(id or name)/logs` Get `stdout` and `stderr` logs from the container ``id`` @@ -724,7 +724,7 @@ Status Codes: ### Inspect changes on a container's filesystem -`GET /containers/(id)/changes` +`GET /containers/(id or name)/changes` Inspect changes on container `id`'s filesystem @@ -766,7 +766,7 @@ Status Codes: ### Export a container -`GET /containers/(id)/export` +`GET /containers/(id or name)/export` Export the contents of container `id` @@ -789,7 +789,7 @@ Status Codes: ### Get container stats based on resource usage -`GET /containers/(id)/stats` +`GET /containers/(id or name)/stats` This endpoint returns a live stream of a container's resource usage statistics. @@ -893,7 +893,7 @@ Status Codes: ### Resize a container TTY -`POST /containers/(id)/resize` +`POST /containers/(id or name)/resize` Resize the TTY for container with `id`. The unit is number of characters. You must restart the container for the resize to take effect. @@ -920,7 +920,7 @@ Status Codes: ### Start a container -`POST /containers/(id)/start` +`POST /containers/(id or name)/start` Start the container `id` @@ -930,7 +930,7 @@ Start the container `id` **Example request**: - POST /containers/(id)/start HTTP/1.1 + POST /containers/e90e34656806/start HTTP/1.1 **Example response**: @@ -951,7 +951,7 @@ Status Codes: ### Stop a container -`POST /containers/(id)/stop` +`POST /containers/(id or name)/stop` Stop the container `id` @@ -976,7 +976,7 @@ Status Codes: ### Restart a container -`POST /containers/(id)/restart` +`POST /containers/(id or name)/restart` Restart the container `id` @@ -1000,7 +1000,7 @@ Status Codes: ### Kill a container -`POST /containers/(id)/kill` +`POST /containers/(id or name)/kill` Kill the container `id` @@ -1025,13 +1025,13 @@ Status Codes: ### Update a container -`POST /containers/(id)/update` +`POST /containers/(id or name)/update` Update resource configs of one or more containers. **Example request**: - POST /containers/(id)/update HTTP/1.1 + POST /containers/e90e34656806/update HTTP/1.1 Content-Type: application/json { @@ -1065,7 +1065,7 @@ Status Codes: ### Rename a container -`POST /containers/(id)/rename` +`POST /containers/(id or name)/rename` Rename the container `id` to a `new_name` @@ -1090,7 +1090,7 @@ Status Codes: ### Pause a container -`POST /containers/(id)/pause` +`POST /containers/(id or name)/pause` Pause the container `id` @@ -1110,7 +1110,7 @@ Status Codes: ### Unpause a container -`POST /containers/(id)/unpause` +`POST /containers/(id or name)/unpause` Unpause the container `id` @@ -1130,7 +1130,7 @@ Status Codes: ### Attach to a container -`POST /containers/(id)/attach` +`POST /containers/(id or name)/attach` Attach to the container `id` @@ -1216,7 +1216,7 @@ Status Codes: ### Attach to a container (websocket) -`GET /containers/(id)/attach/ws` +`GET /containers/(id or name)/attach/ws` Attach to the container `id` via websocket @@ -1254,7 +1254,7 @@ Status Codes: ### Wait a container -`POST /containers/(id)/wait` +`POST /containers/(id or name)/wait` Block until container `id` stops, then returns the exit code @@ -1277,7 +1277,7 @@ Status Codes: ### Remove a container -`DELETE /containers/(id)` +`DELETE /containers/(id or name)` Remove the container `id` from the filesystem @@ -1305,7 +1305,7 @@ Status Codes: ### Copy files or folders from a container -`POST /containers/(id)/copy` +`POST /containers/(id or name)/copy` Copy files or folders of container `id` @@ -1335,14 +1335,14 @@ Status Codes: ### Retrieving information about files and folders in a container -`HEAD /containers/(id)/archive` +`HEAD /containers/(id or name)/archive` See the description of the `X-Docker-Container-Path-Stat` header in the following section. ### Get an archive of a filesystem resource in a container -`GET /containers/(id)/archive` +`GET /containers/(id or name)/archive` Get an tar archive of a resource in the filesystem of container `id`. @@ -1403,7 +1403,7 @@ Status Codes: ### Extract an archive of files or folders to a directory in a container -`PUT /containers/(id)/archive` +`PUT /containers/(id or name)/archive` Upload a tar archive to be extracted to a path in the filesystem of container `id`. @@ -2481,7 +2481,7 @@ the root that contains a list of repository and tag names mapped to layer IDs. ### Exec Create -`POST /containers/(id)/exec` +`POST /containers/(id or name)/exec` Sets up an exec instance in a running container `id` @@ -2567,7 +2567,7 @@ Status Codes: - **409** - container is paused **Stream details**: - Similar to the stream behavior of `POST /container/(id)/attach` API + Similar to the stream behavior of `POST /containers/(id or name)/attach` API ### Exec Resize diff --git a/docs/reference/api/docker_remote_api_v1.23.md b/docs/reference/api/docker_remote_api_v1.23.md index ebee12e68c..45ecd8dbb6 100644 --- a/docs/reference/api/docker_remote_api_v1.23.md +++ b/docs/reference/api/docker_remote_api_v1.23.md @@ -422,7 +422,7 @@ Status Codes: ### Inspect a container -`GET /containers/(id)/json` +`GET /containers/(id or name)/json` Return low-level information on the container `id` @@ -624,7 +624,7 @@ Status Codes: ### List processes running inside a container -`GET /containers/(id)/top` +`GET /containers/(id or name)/top` List processes running inside the container `id`. On Unix systems this is done by running the `ps` command. This endpoint is not @@ -688,7 +688,7 @@ Status Codes: ### Get container logs -`GET /containers/(id)/logs` +`GET /containers/(id or name)/logs` Get `stdout` and `stderr` logs from the container ``id`` @@ -728,7 +728,7 @@ Status Codes: ### Inspect changes on a container's filesystem -`GET /containers/(id)/changes` +`GET /containers/(id or name)/changes` Inspect changes on container `id`'s filesystem @@ -770,7 +770,7 @@ Status Codes: ### Export a container -`GET /containers/(id)/export` +`GET /containers/(id or name)/export` Export the contents of container `id` @@ -793,7 +793,7 @@ Status Codes: ### Get container stats based on resource usage -`GET /containers/(id)/stats` +`GET /containers/(id or name)/stats` This endpoint returns a live stream of a container's resource usage statistics. @@ -897,7 +897,7 @@ Status Codes: ### Resize a container TTY -`POST /containers/(id)/resize` +`POST /containers/(id or name)/resize` Resize the TTY for container with `id`. The unit is number of characters. You must restart the container for the resize to take effect. @@ -924,7 +924,7 @@ Status Codes: ### Start a container -`POST /containers/(id)/start` +`POST /containers/(id or name)/start` Start the container `id` @@ -934,7 +934,7 @@ Start the container `id` **Example request**: - POST /containers/(id)/start HTTP/1.1 + POST /containers/e90e34656806/start HTTP/1.1 **Example response**: @@ -955,7 +955,7 @@ Status Codes: ### Stop a container -`POST /containers/(id)/stop` +`POST /containers/(id or name)/stop` Stop the container `id` @@ -980,7 +980,7 @@ Status Codes: ### Restart a container -`POST /containers/(id)/restart` +`POST /containers/(id or name)/restart` Restart the container `id` @@ -1004,7 +1004,7 @@ Status Codes: ### Kill a container -`POST /containers/(id)/kill` +`POST /containers/(id or name)/kill` Kill the container `id` @@ -1029,13 +1029,13 @@ Status Codes: ### Update a container -`POST /containers/(id)/update` +`POST /containers/(id or name)/update` Update configuration of one or more containers. **Example request**: - POST /containers/(id)/update HTTP/1.1 + POST /containers/e90e34656806/update HTTP/1.1 Content-Type: application/json { @@ -1073,7 +1073,7 @@ Status Codes: ### Rename a container -`POST /containers/(id)/rename` +`POST /containers/(id or name)/rename` Rename the container `id` to a `new_name` @@ -1098,7 +1098,7 @@ Status Codes: ### Pause a container -`POST /containers/(id)/pause` +`POST /containers/(id or name)/pause` Pause the container `id` @@ -1118,7 +1118,7 @@ Status Codes: ### Unpause a container -`POST /containers/(id)/unpause` +`POST /containers/(id or name)/unpause` Unpause the container `id` @@ -1138,7 +1138,7 @@ Status Codes: ### Attach to a container -`POST /containers/(id)/attach` +`POST /containers/(id or name)/attach` Attach to the container `id` @@ -1224,7 +1224,7 @@ Status Codes: ### Attach to a container (websocket) -`GET /containers/(id)/attach/ws` +`GET /containers/(id or name)/attach/ws` Attach to the container `id` via websocket @@ -1262,7 +1262,7 @@ Status Codes: ### Wait a container -`POST /containers/(id)/wait` +`POST /containers/(id or name)/wait` Block until container `id` stops, then returns the exit code @@ -1285,7 +1285,7 @@ Status Codes: ### Remove a container -`DELETE /containers/(id)` +`DELETE /containers/(id or name)` Remove the container `id` from the filesystem @@ -1313,7 +1313,7 @@ Status Codes: ### Copy files or folders from a container -`POST /containers/(id)/copy` +`POST /containers/(id or name)/copy` Copy files or folders of container `id` @@ -1343,14 +1343,14 @@ Status Codes: ### Retrieving information about files and folders in a container -`HEAD /containers/(id)/archive` +`HEAD /containers/(id or name)/archive` See the description of the `X-Docker-Container-Path-Stat` header in the following section. ### Get an archive of a filesystem resource in a container -`GET /containers/(id)/archive` +`GET /containers/(id or name)/archive` Get an tar archive of a resource in the filesystem of container `id`. @@ -1411,7 +1411,7 @@ Status Codes: ### Extract an archive of files or folders to a directory in a container -`PUT /containers/(id)/archive` +`PUT /containers/(id or name)/archive` Upload a tar archive to be extracted to a path in the filesystem of container `id`. @@ -2489,7 +2489,7 @@ the root that contains a list of repository and tag names mapped to layer IDs. ### Exec Create -`POST /containers/(id)/exec` +`POST /containers/(id or name)/exec` Sets up an exec instance in a running container `id` @@ -2575,7 +2575,7 @@ Status Codes: - **409** - container is paused **Stream details**: - Similar to the stream behavior of `POST /container/(id)/attach` API + Similar to the stream behavior of `POST /containers/(id or name)/attach` API ### Exec Resize