Browse code
Documenting Container Tty resize api
Addresses #7840
Signed-off-by: Srini Brahmaroutu <srbrahma@us.ibm.com>
Srini Brahmaroutu authored on 2014/09/26 06:41:32Showing 3 changed files
- docs/sources/http-routingtable.md
- docs/sources/reference/api/docker_remote_api_v1.15.md
- docs/sources/reference/api/docker_remote_api_v1.9.md
| ... | ... |
@@ -44,6 +44,7 @@ |
| 44 | 44 |
[`POST /containers/(id)/wait`](../reference/api/docker_remote_api_v1.9/#post--containers-(id)-wait) ** |
| 45 | 45 |
[`POST /containers/create`](../reference/api/docker_remote_api_v1.9/#post--containers-create) ** |
| 46 | 46 |
[`GET /containers/json`](../reference/api/docker_remote_api_v1.9/#get--containers-json) ** |
| 47 |
+ [`GET /containers/resize`](../reference/api/docker_remote_api_v1.9/#get--containers-resize) ** |
|
| 47 | 48 |
|
| 48 | 49 |
**/events** |
| 49 | 50 |
[`GET /events`](../reference/api/docker_remote_api_v1.9/#get--events) ** |
| ... | ... |
@@ -393,6 +393,28 @@ Status Codes: |
| 393 | 393 |
- **404** – no such container |
| 394 | 394 |
- **500** – server error |
| 395 | 395 |
|
| 396 |
+### Resize a container TTY |
|
| 397 |
+ |
|
| 398 |
+`GET /containers/(id)/resize?h=<height>&w=<width>` |
|
| 399 |
+ |
|
| 400 |
+Resize the TTY of container `id` |
|
| 401 |
+ |
|
| 402 |
+**Example request**: |
|
| 403 |
+ |
|
| 404 |
+ GET /containers/4fa6e0f0c678/resize?h=40&w=80 HTTP/1.1 |
|
| 405 |
+ |
|
| 406 |
+**Example response**: |
|
| 407 |
+ |
|
| 408 |
+ HTTP/1.1 200 OK |
|
| 409 |
+ Content-Length: 0 |
|
| 410 |
+ Content-Type: text/plain; charset=utf-8 |
|
| 411 |
+ |
|
| 412 |
+Status Codes: |
|
| 413 |
+ |
|
| 414 |
+- **200** – no error |
|
| 415 |
+- **404** – No such container |
|
| 416 |
+- **500** – bad file descriptor |
|
| 417 |
+ |
|
| 396 | 418 |
### Start a container |
| 397 | 419 |
|
| 398 | 420 |
`POST /containers/(id)/start` |
| ... | ... |
@@ -364,6 +364,28 @@ Status Codes: |
| 364 | 364 |
- **404** – no such container |
| 365 | 365 |
- **500** – server error |
| 366 | 366 |
|
| 367 |
+### Resize a container TTY |
|
| 368 |
+ |
|
| 369 |
+`GET /containers/(id)/resize?h=<height>&w=<width>` |
|
| 370 |
+ |
|
| 371 |
+Resize the TTY of container `id` |
|
| 372 |
+ |
|
| 373 |
+**Example request**: |
|
| 374 |
+ |
|
| 375 |
+ GET /containers/4fa6e0f0c678/resize?h=40&w=80 HTTP/1.1 |
|
| 376 |
+ |
|
| 377 |
+**Example response**: |
|
| 378 |
+ |
|
| 379 |
+ HTTP/1.1 200 OK |
|
| 380 |
+ Content-Length: 0 |
|
| 381 |
+ Content-Type: text/plain; charset=utf-8 |
|
| 382 |
+ |
|
| 383 |
+Status Codes: |
|
| 384 |
+ |
|
| 385 |
+- **200** – no error |
|
| 386 |
+- **404** – No such container |
|
| 387 |
+- **500** – bad file descriptor |
|
| 388 |
+ |
|
| 367 | 389 |
### Start a container |
| 368 | 390 |
|
| 369 | 391 |
`POST /containers/(id)/start` |