1. docker
  2. Commit 01940944e4fc7de5d1e271df9e6afa5013bbcf17
Browse code

Merge pull request #25441 from thaJeztah/sync-api-docs

Sync API docs to older API versions
(cherry picked from commit f4575970a7a9c052b2a45c1a9b66ba2333a4d824)

Sebastiaan van Stijn authored on 2016/08/06 01:05:38
Showing 6 changed files
docs/reference/api/docker_remote_api_v1.18.md
History View file @ 0194094
... ... 
@@ -19,6 +19,8 @@ weight = 3
19 19 
  - The API tends to be REST, but for some complex commands, like `attach`
20 20 
    or `pull`, the HTTP connection is hijacked to transport `STDOUT`,
21 21 
    `STDIN` and `STDERR`.
22 
+ - When the client API version is newer than the daemon's, these calls return an HTTP
23 
+   `400 Bad Request` error message.
22 24
23 25 
 # 2. Endpoints
24 26
... ... 
@@ -32,69 +34,69 @@ List containers
32 32
33 33 
 **Example request**:
34 34
35 
-        GET /containers/json?all=1&before=8dfafdbc3a40&size=1 HTTP/1.1
35 
+    GET /containers/json?all=1&before=8dfafdbc3a40&size=1 HTTP/1.1
36 36
37 37 
 **Example response**:
38 38
39 
-        HTTP/1.1 200 OK
40 
-        Content-Type: application/json
41 
-
42 
-        [
43 
-             {
44 
-                     "Id": "8dfafdbc3a40",
45 
-                     "Names":["/boring_feynman"],
46 
-                     "Image": "ubuntu:latest",
47 
-                     "Command": "echo 1",
48 
-                     "Created": 1367854155,
49 
-                     "Status": "Exit 0",
50 
-                     "Ports": [{"PrivatePort": 2222, "PublicPort": 3333, "Type": "tcp"}],
51 
-                     "Labels": {
52 
-                             "com.example.vendor": "Acme",
53 
-                             "com.example.license": "GPL",
54 
-                             "com.example.version": "1.0"
55 
-                     },
56 
-                     "SizeRw": 12288,
57 
-                     "SizeRootFs": 0
58 
-             },
59 
-             {
60 
-                     "Id": "9cd87474be90",
61 
-                     "Names":["/coolName"],
62 
-                     "Image": "ubuntu:latest",
63 
-                     "Command": "echo 222222",
64 
-                     "Created": 1367854155,
65 
-                     "Status": "Exit 0",
66 
-                     "Ports": [],
67 
-                     "Labels": {},
68 
-                     "SizeRw": 12288,
69 
-                     "SizeRootFs": 0
70 
-             },
71 
-             {
72 
-                     "Id": "3176a2479c92",
73 
-                     "Names":["/sleepy_dog"],
74 
-                     "Image": "ubuntu:latest",
75 
-                     "Command": "echo 3333333333333333",
76 
-                     "Created": 1367854154,
77 
-                     "Status": "Exit 0",
78 
-                     "Ports":[],
79 
-                     "Labels": {},
80 
-                     "SizeRw":12288,
81 
-                     "SizeRootFs":0
82 
-             },
83 
-             {
84 
-                     "Id": "4cb07b47f9fb",
85 
-                     "Names":["/running_cat"],
86 
-                     "Image": "ubuntu:latest",
87 
-                     "Command": "echo 444444444444444444444444444444444",
88 
-                     "Created": 1367854152,
89 
-                     "Status": "Exit 0",
90 
-                     "Ports": [],
91 
-                     "Labels": {},
92 
-                     "SizeRw": 12288,
93 
-                     "SizeRootFs": 0
94 
-             }
95 
-        ]
39 
+    HTTP/1.1 200 OK
40 
+    Content-Type: application/json
96 41
97 
-Query Parameters:
42 
+    [
43 
+         {
44 
+                 "Id": "8dfafdbc3a40",
45 
+                 "Names":["/boring_feynman"],
46 
+                 "Image": "ubuntu:latest",
47 
+                 "Command": "echo 1",
48 
+                 "Created": 1367854155,
49 
+                 "Status": "Exit 0",
50 
+                 "Ports": [{"PrivatePort": 2222, "PublicPort": 3333, "Type": "tcp"}],
51 
+                 "Labels": {
52 
+                         "com.example.vendor": "Acme",
53 
+                         "com.example.license": "GPL",
54 
+                         "com.example.version": "1.0"
55 
+                 },
56 
+                 "SizeRw": 12288,
57 
+                 "SizeRootFs": 0
58 
+         },
59 
+         {
60 
+                 "Id": "9cd87474be90",
61 
+                 "Names":["/coolName"],
62 
+                 "Image": "ubuntu:latest",
63 
+                 "Command": "echo 222222",
64 
+                 "Created": 1367854155,
65 
+                 "Status": "Exit 0",
66 
+                 "Ports": [],
67 
+                 "Labels": {},
68 
+                 "SizeRw": 12288,
69 
+                 "SizeRootFs": 0
70 
+         },
71 
+         {
72 
+                 "Id": "3176a2479c92",
73 
+                 "Names":["/sleepy_dog"],
74 
+                 "Image": "ubuntu:latest",
75 
+                 "Command": "echo 3333333333333333",
76 
+                 "Created": 1367854154,
77 
+                 "Status": "Exit 0",
78 
+                 "Ports":[],
79 
+                 "Labels": {},
80 
+                 "SizeRw":12288,
81 
+                 "SizeRootFs":0
82 
+         },
83 
+         {
84 
+                 "Id": "4cb07b47f9fb",
85 
+                 "Names":["/running_cat"],
86 
+                 "Image": "ubuntu:latest",
87 
+                 "Command": "echo 444444444444444444444444444444444",
88 
+                 "Created": 1367854152,
89 
+                 "Status": "Exit 0",
90 
+                 "Ports": [],
91 
+                 "Labels": {},
92 
+                 "SizeRw": 12288,
93 
+                 "SizeRootFs": 0
94 
+         }
95 
+    ]
96 
+
97 
+**Query parameters**:
98 98
99 99 
 -   **all** – 1/True/true or 0/False/false, Show all containers.
100 100 
         Only running containers are shown by default (i.e., this defaults to false)
... ... 
@@ -106,12 +108,12 @@ Query Parameters:
106 106 
         non-running ones.
107 107 
 -   **size** – 1/True/true or 0/False/false, Show the containers
108 108 
         sizes
109 
--   **filters** - a json encoded value of the filters (a map[string][]string) to process on the containers list. Available filters:
110 
-  -   exited=<int> -- containers with exit code of <int>
111 
-  -   status=(restarting|running|paused|exited)
112 
-  -   label=`key` or `label="key=value"` of a container label
109 
+-   **filters** - a JSON encoded value of the filters (a `map[string][]string`) to process on the containers list. Available filters:
110 
+  -   `exited=<int>`; -- containers with exit code of  `<int>` ;
111 
+  -   `status=`(`restarting`|`running`|`paused`|`exited`)
112 
+  -   `label=key` or `label="key=value"` of a container label
113 113
114 
-Status Codes:
114 
+**Status codes**:
115 115
116 116 
 -   **200** – no error
117 117 
 -   **400** – bad parameter
... ... 
@@ -125,7 +127,7 @@ Create a container
125 125
126 126 
 **Example request**:
127 127
128 
-        POST /containers/create HTTP/1.1
128 
+      POST /containers/create HTTP/1.1
129 129 
         Content-Type: application/json
130 130
131 131 
         {
... ... 
@@ -200,7 +202,7 @@ Create a container
200 200 
              "Warnings":[]
201 201 
         }
202 202
203 
-Json Parameters:
203 
+**JSON parameters**:
204 204
205 205 
 -   **Hostname** - A string value containing the desired hostname to use for the
206 206 
       container.
... ... 
@@ -288,12 +290,12 @@ Json Parameters:
288 288 
           `json-file` logging driver.
289 289 
     -   **CgroupParent** - Path to cgroups under which the cgroup for the container will be created. If the path is not absolute, the path is considered to be relative to the cgroups path of the init process. Cgroups will be created if they do not already exist.
290 290
291 
-Query Parameters:
291 
+**Query parameters**:
292 292
293 293 
 -   **name** – Assign the specified name to the container. Must
294 294 
     match `/?[a-zA-Z0-9_-]+`.
295 295
296 
-Status Codes:
296 
+**Status codes**:
297 297
298 298 
 -   **201** – no error
299 299 
 -   **400** – bad parameter
... ... 
@@ -308,15 +310,14 @@ Status Codes:
308 308
309 309 
 Return low-level information on the container `id`
310 310
311 
-
312 311 
 **Example request**:
313 312
314 
-        GET /containers/4fa6e0f0c678/json HTTP/1.1
313 
+      GET /containers/4fa6e0f0c678/json HTTP/1.1
315 314
316 315 
 **Example response**:
317 316
318 
-        HTTP/1.1 200 OK
319 
-        Content-Type: application/json
317 
+    HTTP/1.1 200 OK
318 
+    Content-Type: application/json
320 319
321 320 
 	{
322 321 
 		"AppArmorProfile": "",
... ... 
@@ -430,7 +431,7 @@ Return low-level information on the container `id`
430 430 
 		"VolumesRW": {}
431 431 
 	}
432 432
433 
-Status Codes:
433 
+**Status codes**:
434 434
435 435 
 -   **200** – no error
436 436 
 -   **404** – no such container
... ... 
@@ -490,11 +491,11 @@ supported on Windows.
490 490 
       ],
491 491 
     }
492 492
493 
-Query Parameters:
493 
+**Query parameters**:
494 494
495 495 
 -   **ps_args** – `ps` arguments to use (e.g., `aux`), defaults to `-ef`
496 496
497 
-Status Codes:
497 
+**Status codes**:
498 498
499 499 
 -   **200** – no error
500 500 
 -   **404** – no such container
... ... 
@@ -504,25 +505,25 @@ Status Codes:
504 504
505 505 
 `GET /containers/(id or name)/logs`
506 506
507 
-Get stdout and stderr logs from the container ``id``
507 
+Get `stdout` and `stderr` logs from the container ``id``
508 508
509 509 
 > **Note**:
510 510 
 > This endpoint works only for containers with the `json-file` or `journald` logging drivers.
511 511
512 512 
 **Example request**:
513 513
514 
-       GET /containers/4fa6e0f0c678/logs?stderr=1&stdout=1&timestamps=1&follow=1&tail=10 HTTP/1.1
514 
+     GET /containers/4fa6e0f0c678/logs?stderr=1&stdout=1&timestamps=1&follow=1&tail=10 HTTP/1.1
515 515
516 516 
 **Example response**:
517 517
518 
-       HTTP/1.1 101 UPGRADED
519 
-       Content-Type: application/vnd.docker.raw-stream
520 
-       Connection: Upgrade
521 
-       Upgrade: tcp
518 
+     HTTP/1.1 101 UPGRADED
519 
+     Content-Type: application/vnd.docker.raw-stream
520 
+     Connection: Upgrade
521 
+     Upgrade: tcp
522 522
523 
-       {{ STREAM }}
523 
+     {{ STREAM }}
524 524
525 
-Query Parameters:
525 
+**Query parameters**:
526 526
527 527 
 -   **follow** – 1/True/true or 0/False/false, return stream. Default false
528 528 
 -   **stdout** – 1/True/true or 0/False/false, show stdout log. Default false
... ... 
@@ -531,7 +532,7 @@ Query Parameters:
531 531 
         every log line. Default false
532 532 
 -   **tail** – Output specified number of lines at the end of logs: `all` or `<number>`. Default all
533 533
534 
-Status Codes:
534 
+**Status codes**:
535 535
536 536 
 -   **101** – no error, hints proxy about hijacking
537 537 
 -   **200** – no error, no upgrade header found
... ... 
@@ -546,27 +547,27 @@ Inspect changes on container `id`'s filesystem
546 546
547 547 
 **Example request**:
548 548
549 
-        GET /containers/4fa6e0f0c678/changes HTTP/1.1
549 
+    GET /containers/4fa6e0f0c678/changes HTTP/1.1
550 550
551 551 
 **Example response**:
552 552
553 
-        HTTP/1.1 200 OK
554 
-        Content-Type: application/json
553 
+    HTTP/1.1 200 OK
554 
+    Content-Type: application/json
555 555
556 
-        [
557 
-             {
558 
-                     "Path": "/dev",
559 
-                     "Kind": 0
560 
-             },
561 
-             {
562 
-                     "Path": "/dev/kmsg",
563 
-                     "Kind": 1
564 
-             },
565 
-             {
566 
-                     "Path": "/test",
567 
-                     "Kind": 1
568 
-             }
569 
-        ]
556 
+    [
557 
+         {
558 
+                 "Path": "/dev",
559 
+                 "Kind": 0
560 
+         },
561 
+         {
562 
+                 "Path": "/dev/kmsg",
563 
+                 "Kind": 1
564 
+         },
565 
+         {
566 
+                 "Path": "/test",
567 
+                 "Kind": 1
568 
+         }
569 
+    ]
570 570
571 571 
 Values for `Kind`:
572 572
... ... 
@@ -574,7 +575,7 @@ Values for `Kind`:
574 574 
 - `1`: Add
575 575 
 - `2`: Delete
576 576
577 
-Status Codes:
577 
+**Status codes**:
578 578
579 579 
 -   **200** – no error
580 580 
 -   **404** – no such container
... ... 
@@ -588,16 +589,16 @@ Export the contents of container `id`
588 588
589 589 
 **Example request**:
590 590
591 
-        GET /containers/4fa6e0f0c678/export HTTP/1.1
591 
+    GET /containers/4fa6e0f0c678/export HTTP/1.1
592 592
593 593 
 **Example response**:
594 594
595 
-        HTTP/1.1 200 OK
596 
-        Content-Type: application/octet-stream
595 
+    HTTP/1.1 200 OK
596 
+    Content-Type: application/octet-stream
597 597
598 
-        {{ TAR STREAM }}
598 
+    {{ TAR STREAM }}
599 599
600 
-Status Codes:
600 
+**Status codes**:
601 601
602 602 
 -   **200** – no error
603 603 
 -   **404** – no such container
... ... 
@@ -685,7 +686,7 @@ This endpoint returns a live stream of a container's resource usage statistics.
685 685 
            }
686 686 
         }
687 687
688 
-Status Codes:
688 
+**Status codes**:
689 689
690 690 
 -   **200** – no error
691 691 
 -   **404** – no such container
... ... 
@@ -695,19 +696,24 @@ Status Codes:
695 695
696 696 
 `POST /containers/(id or name)/resize?h=<height>&w=<width>`
697 697
698 
-Resize the TTY for container with  `id`. The container must be restarted for the resize to take effect.
698 
+Resize the TTY for container with  `id`. You must restart the container for the resize to take effect.
699 699
700 700 
 **Example request**:
701 701
702 
-        POST /containers/4fa6e0f0c678/resize?h=40&w=80 HTTP/1.1
702 
+      POST /containers/4fa6e0f0c678/resize?h=40&w=80 HTTP/1.1
703 703
704 704 
 **Example response**:
705 705
706 
-        HTTP/1.1 200 OK
707 
-        Content-Length: 0
708 
-        Content-Type: text/plain; charset=utf-8
706 
+      HTTP/1.1 200 OK
707 
+      Content-Length: 0
708 
+      Content-Type: text/plain; charset=utf-8
709 709
710 
-Status Codes:
710 
+**Query parameters**:
711 
+
712 
+-   **h** – height of `tty` session
713 
+-   **w** – width
714 
+
715 
+**Status codes**:
711 716
712 717 
 -   **200** – no error
713 718 
 -   **404** – No such container
... ... 
@@ -725,13 +731,13 @@ Start the container `id`
725 725
726 726 
 **Example request**:
727 727
728 
-        POST /containers/e90e34656806/start HTTP/1.1
728 
+    POST /containers/e90e34656806/start HTTP/1.1
729 729
730 730 
 **Example response**:
731 731
732 
-        HTTP/1.1 204 No Content
732 
+    HTTP/1.1 204 No Content
733 733
734 
-Status Codes:
734 
+**Status codes**:
735 735
736 736 
 -   **204** – no error
737 737 
 -   **304** – container already started
... ... 
@@ -746,17 +752,17 @@ Stop the container `id`
746 746
747 747 
 **Example request**:
748 748
749 
-        POST /containers/e90e34656806/stop?t=5 HTTP/1.1
749 
+    POST /containers/e90e34656806/stop?t=5 HTTP/1.1
750 750
751 751 
 **Example response**:
752 752
753 
-        HTTP/1.1 204 No Content
753 
+    HTTP/1.1 204 No Content
754 754
755 
-Query Parameters:
755 
+**Query parameters**:
756 756
757 757 
 -   **t** – number of seconds to wait before killing the container
758 758
759 
-Status Codes:
759 
+**Status codes**:
760 760
761 761 
 -   **204** – no error
762 762 
 -   **304** – container already stopped
... ... 
@@ -771,17 +777,17 @@ Restart the container `id`
771 771
772 772 
 **Example request**:
773 773
774 
-        POST /containers/e90e34656806/restart?t=5 HTTP/1.1
774 
+    POST /containers/e90e34656806/restart?t=5 HTTP/1.1
775 775
776 776 
 **Example response**:
777 777
778 
-        HTTP/1.1 204 No Content
778 
+    HTTP/1.1 204 No Content
779 779
780 
-Query Parameters:
780 
+**Query parameters**:
781 781
782 782 
 -   **t** – number of seconds to wait before killing the container
783 783
784 
-Status Codes:
784 
+**Status codes**:
785 785
786 786 
 -   **204** – no error
787 787 
 -   **404** – no such container
... ... 
@@ -795,18 +801,18 @@ Kill the container `id`
795 795
796 796 
 **Example request**:
797 797
798 
-        POST /containers/e90e34656806/kill HTTP/1.1
798 
+    POST /containers/e90e34656806/kill HTTP/1.1
799 799
800 800 
 **Example response**:
801 801
802 
-        HTTP/1.1 204 No Content
802 
+    HTTP/1.1 204 No Content
803 803
804 
-Query Parameters
804 
+**Query parameters**:
805 805
806 
--   **signal** - Signal to send to the container: integer or string like "SIGINT".
807 
-        When not set, SIGKILL is assumed and the call will waits for the container to exit.
806 
+-   **signal** - Signal to send to the container: integer or string like `SIGINT`.
807 
+        When not set, `SIGKILL` is assumed and the call waits for the container to exit.
808 808
809 
-Status Codes:
809 
+**Status codes**:
810 810
811 811 
 -   **204** – no error
812 812 
 -   **404** – no such container
... ... 
@@ -820,17 +826,17 @@ Rename the container `id` to a `new_name`
820 820
821 821 
 **Example request**:
822 822
823 
-        POST /containers/e90e34656806/rename?name=new_name HTTP/1.1
823 
+    POST /containers/e90e34656806/rename?name=new_name HTTP/1.1
824 824
825 825 
 **Example response**:
826 826
827 
-        HTTP/1.1 204 No Content
827 
+    HTTP/1.1 204 No Content
828 828
829 
-Query Parameters:
829 
+**Query parameters**:
830 830
831 831 
 -   **name** – new name for the container
832 832
833 
-Status Codes:
833 
+**Status codes**:
834 834
835 835 
 -   **204** – no error
836 836 
 -   **404** – no such container
... ... 
@@ -845,13 +851,13 @@ Pause the container `id`
845 845
846 846 
 **Example request**:
847 847
848 
-        POST /containers/e90e34656806/pause HTTP/1.1
848 
+    POST /containers/e90e34656806/pause HTTP/1.1
849 849
850 850 
 **Example response**:
851 851
852 
-        HTTP/1.1 204 No Content
852 
+    HTTP/1.1 204 No Content
853 853
854 
-Status Codes:
854 
+**Status codes**:
855 855
856 856 
 -   **204** – no error
857 857 
 -   **404** – no such container
... ... 
@@ -865,13 +871,13 @@ Unpause the container `id`
865 865
866 866 
 **Example request**:
867 867
868 
-        POST /containers/e90e34656806/unpause HTTP/1.1
868 
+    POST /containers/e90e34656806/unpause HTTP/1.1
869 869
870 870 
 **Example response**:
871 871
872 
-        HTTP/1.1 204 No Content
872 
+    HTTP/1.1 204 No Content
873 873
874 
-Status Codes:
874 
+**Status codes**:
875 875
876 876 
 -   **204** – no error
877 877 
 -   **404** – no such container
... ... 
@@ -885,30 +891,30 @@ Attach to the container `id`
885 885
886 886 
 **Example request**:
887 887
888 
-        POST /containers/16253994b7c4/attach?logs=1&stream=0&stdout=1 HTTP/1.1
888 
+    POST /containers/16253994b7c4/attach?logs=1&stream=0&stdout=1 HTTP/1.1
889 889
890 890 
 **Example response**:
891 891
892 
-        HTTP/1.1 101 UPGRADED
893 
-        Content-Type: application/vnd.docker.raw-stream
894 
-        Connection: Upgrade
895 
-        Upgrade: tcp
892 
+    HTTP/1.1 101 UPGRADED
893 
+    Content-Type: application/vnd.docker.raw-stream
894 
+    Connection: Upgrade
895 
+    Upgrade: tcp
896 896
897 
-        {{ STREAM }}
897 
+    {{ STREAM }}
898 898
899 
-Query Parameters:
899 
+**Query parameters**:
900 900
901 
--   **logs** – 1/True/true or 0/False/false, return logs. Default false
901 
+-   **logs** – 1/True/true or 0/False/false, return logs. Default `false`.
902 902 
 -   **stream** – 1/True/true or 0/False/false, return stream.
903 
-        Default false
904 
--   **stdin** – 1/True/true or 0/False/false, if stream=true, attach
905 
-        to stdin. Default false
906 
--   **stdout** – 1/True/true or 0/False/false, if logs=true, return
907 
-        stdout log, if stream=true, attach to stdout. Default false
908 
--   **stderr** – 1/True/true or 0/False/false, if logs=true, return
909 
-        stderr log, if stream=true, attach to stderr. Default false
903 
+        Default `false`.
904 
+-   **stdin** – 1/True/true or 0/False/false, if `stream=true`, attach
905 
+        to `stdin`. Default `false`.
906 
+-   **stdout** – 1/True/true or 0/False/false, if `logs=true`, return
907 
+        `stdout` log, if `stream=true`, attach to `stdout`. Default `false`.
908 
+-   **stderr** – 1/True/true or 0/False/false, if `logs=true`, return
909 
+        `stderr` log, if `stream=true`, attach to `stderr`. Default `false`.
910 910
911 
-Status Codes:
911 
+**Status codes**:
912 912
913 913 
 -   **101** – no error, hints proxy about hijacking
914 914 
 -   **200** – no error, no upgrade header found
... ... 
@@ -921,30 +927,30 @@ Status Codes:
921 921 
     When using the TTY setting is enabled in
922 922 
     [`POST /containers/create`
923 923 
     ](#create-a-container),
924 
-    the stream is the raw data from the process PTY and client's stdin.
924 
+    the stream is the raw data from the process PTY and client's `stdin`.
925 925 
     When the TTY is disabled, then the stream is multiplexed to separate
926 
-    stdout and stderr.
926 
+    `stdout` and `stderr`.
927 927
928 928 
     The format is a **Header** and a **Payload** (frame).
929 929
930 930 
     **HEADER**
931 931
932 
-    The header will contain the information on which stream write the
933 
-    stream (stdout or stderr). It also contain the size of the
934 
-    associated frame encoded on the last 4 bytes (uint32).
932 
+    The header contains the information which the stream writes (`stdout` or
933 
+    `stderr`). It also contains the size of the associated frame encoded in the
934 
+    last four bytes (`uint32`).
935 935
936 
-    It is encoded on the first 8 bytes like this:
936 
+    It is encoded on the first eight bytes like this:
937 937
938 938 
         header := [8]byte{STREAM_TYPE, 0, 0, 0, SIZE1, SIZE2, SIZE3, SIZE4}
939 939
940 940 
     `STREAM_TYPE` can be:
941 941
942 
--   0: stdin (will be written on stdout)
943 
--   1: stdout
944 
--   2: stderr
942 
+-   0: `stdin` (is written on `stdout`)
943 
+-   1: `stdout`
944 
+-   2: `stderr`
945 945
946 
-    `SIZE1, SIZE2, SIZE3, SIZE4` are the 4 bytes of
947 
-    the uint32 size encoded as big endian.
946 
+    `SIZE1, SIZE2, SIZE3, SIZE4` are the four bytes of
947 
+    the `uint32` size encoded as big endian.
948 948
949 949 
     **PAYLOAD**
950 950
... ... 
@@ -954,11 +960,11 @@ Status Codes:
954 954
955 955 
     The simplest way to implement the Attach protocol is the following:
956 956
957 
-    1.  Read 8 bytes
958 
-    2.  chose stdout or stderr depending on the first byte
959 
-    3.  Extract the frame size from the last 4 bytes
960 
-    4.  Read the extracted size and output it on the correct output
961 
-    5.  Goto 1
957 
+    1.  Read eight bytes.
958 
+    2.  Choose `stdout` or `stderr` depending on the first byte.
959 
+    3.  Extract the frame size from the last four bytes.
960 
+    4.  Read the extracted size and output it on the correct output.
961 
+    5.  Goto 1.
962 962
963 963 
 ### Attach to a container (websocket)
964 964
... ... 
@@ -970,25 +976,25 @@ Implements websocket protocol handshake according to [RFC 6455](http://tools.iet
970 970
971 971 
 **Example request**
972 972
973 
-        GET /containers/e90e34656806/attach/ws?logs=0&stream=1&stdin=1&stdout=1&stderr=1 HTTP/1.1
973 
+    GET /containers/e90e34656806/attach/ws?logs=0&stream=1&stdin=1&stdout=1&stderr=1 HTTP/1.1
974 974
975 975 
 **Example response**
976 976
977 
-        {{ STREAM }}
977 
+    {{ STREAM }}
978 978
979 
-Query Parameters:
979 
+**Query parameters**:
980 980
981 
--   **logs** – 1/True/true or 0/False/false, return logs. Default false
981 
+-   **logs** – 1/True/true or 0/False/false, return logs. Default `false`.
982 982 
 -   **stream** – 1/True/true or 0/False/false, return stream.
983 
-        Default false
984 
--   **stdin** – 1/True/true or 0/False/false, if stream=true, attach
985 
-        to stdin. Default false
986 
--   **stdout** – 1/True/true or 0/False/false, if logs=true, return
987 
-        stdout log, if stream=true, attach to stdout. Default false
988 
--   **stderr** – 1/True/true or 0/False/false, if logs=true, return
989 
-        stderr log, if stream=true, attach to stderr. Default false
983 
+        Default `false`.
984 
+-   **stdin** – 1/True/true or 0/False/false, if `stream=true`, attach
985 
+        to `stdin`. Default `false`.
986 
+-   **stdout** – 1/True/true or 0/False/false, if `logs=true`, return
987 
+        `stdout` log, if `stream=true`, attach to `stdout`. Default `false`.
988 
+-   **stderr** – 1/True/true or 0/False/false, if `logs=true`, return
989 
+        `stderr` log, if `stream=true`, attach to `stderr`. Default `false`.
990 990
991 
-Status Codes:
991 
+**Status codes**:
992 992
993 993 
 -   **200** – no error
994 994 
 -   **400** – bad parameter
... ... 
@@ -1003,16 +1009,16 @@ Block until container `id` stops, then returns the exit code
1003 1003
1004 1004 
 **Example request**:
1005 1005
1006 
-        POST /containers/16253994b7c4/wait HTTP/1.1
1006 
+    POST /containers/16253994b7c4/wait HTTP/1.1
1007 1007
1008 1008 
 **Example response**:
1009 1009
1010 
-        HTTP/1.1 200 OK
1011 
-        Content-Type: application/json
1010 
+    HTTP/1.1 200 OK
1011 
+    Content-Type: application/json
1012 1012
1013 
-        {"StatusCode": 0}
1013 
+    {"StatusCode": 0}
1014 1014
1015 
-Status Codes:
1015 
+**Status codes**:
1016 1016
1017 1017 
 -   **200** – no error
1018 1018 
 -   **404** – no such container
... ... 
@@ -1026,20 +1032,20 @@ Remove the container `id` from the filesystem
1026 1026
1027 1027 
 **Example request**:
1028 1028
1029 
-        DELETE /containers/16253994b7c4?v=1 HTTP/1.1
1029 
+    DELETE /containers/16253994b7c4?v=1 HTTP/1.1
1030 1030
1031 1031 
 **Example response**:
1032 1032
1033 
-        HTTP/1.1 204 No Content
1033 
+    HTTP/1.1 204 No Content
1034 1034
1035 
-Query Parameters:
1035 
+**Query parameters**:
1036 1036
1037 1037 
 -   **v** – 1/True/true or 0/False/false, Remove the volumes
1038 
-        associated to the container. Default false
1038 
+        associated to the container. Default `false`.
1039 1039 
 -   **force** - 1/True/true or 0/False/false, Kill then remove the container.
1040 
-        Default false
1040 
+        Default `false`.
1041 1041
1042 
-Status Codes:
1042 
+**Status codes**:
1043 1043
1044 1044 
 -   **204** – no error
1045 1045 
 -   **400** – bad parameter
... ... 
@@ -1055,21 +1061,21 @@ Copy files or folders of container `id`
1055 1055
1056 1056 
 **Example request**:
1057 1057
1058 
-        POST /containers/4fa6e0f0c678/copy HTTP/1.1
1059 
-        Content-Type: application/json
1058 
+    POST /containers/4fa6e0f0c678/copy HTTP/1.1
1059 
+    Content-Type: application/json
1060 1060
1061 
-        {
1062 
-             "Resource": "test.txt"
1063 
-        }
1061 
+    {
1062 
+         "Resource": "test.txt"
1063 
+    }
1064 1064
1065 1065 
 **Example response**:
1066 1066
1067 
-        HTTP/1.1 200 OK
1068 
-        Content-Type: application/x-tar
1067 
+    HTTP/1.1 200 OK
1068 
+    Content-Type: application/x-tar
1069 1069
1070 
-        {{ TAR STREAM }}
1070 
+    {{ TAR STREAM }}
1071 1071
1072 
-Status Codes:
1072 
+**Status codes**:
1073 1073
1074 1074 
 -   **200** – no error
1075 1075 
 -   **404** – no such container
... ... 
@@ -1083,63 +1089,63 @@ Status Codes:
1083 1083
1084 1084 
 **Example request**:
1085 1085
1086 
-        GET /images/json?all=0 HTTP/1.1
1086 
+    GET /images/json?all=0 HTTP/1.1
1087 1087
1088 1088 
 **Example response**:
1089 1089
1090 
-        HTTP/1.1 200 OK
1091 
-        Content-Type: application/json
1090 
+    HTTP/1.1 200 OK
1091 
+    Content-Type: application/json
1092 1092
1093 
-        [
1094 
-          {
1095 
-             "RepoTags": [
1096 
-               "ubuntu:12.04",
1097 
-               "ubuntu:precise",
1098 
-               "ubuntu:latest"
1099 
-             ],
1100 
-             "Id": "8dbd9e392a964056420e5d58ca5cc376ef18e2de93b5cc90e868a1bbc8318c1c",
1101 
-             "Created": 1365714795,
1102 
-             "Size": 131506275,
1103 
-             "VirtualSize": 131506275
1104 
-          },
1105 
-          {
1106 
-             "RepoTags": [
1107 
-               "ubuntu:12.10",
1108 
-               "ubuntu:quantal"
1109 
-             ],
1110 
-             "ParentId": "27cf784147099545",
1111 
-             "Id": "b750fe79269d2ec9a3c593ef05b4332b1d1a02a62b4accb2c21d589ff2f5f2dc",
1112 
-             "Created": 1364102658,
1113 
-             "Size": 24653,
1114 
-             "VirtualSize": 180116135
1115 
-          }
1116 
-        ]
1093 
+    [
1094 
+      {
1095 
+         "RepoTags": [
1096 
+           "ubuntu:12.04",
1097 
+           "ubuntu:precise",
1098 
+           "ubuntu:latest"
1099 
+         ],
1100 
+         "Id": "8dbd9e392a964056420e5d58ca5cc376ef18e2de93b5cc90e868a1bbc8318c1c",
1101 
+         "Created": 1365714795,
1102 
+         "Size": 131506275,
1103 
+         "VirtualSize": 131506275
1104 
+      },
1105 
+      {
1106 
+         "RepoTags": [
1107 
+           "ubuntu:12.10",
1108 
+           "ubuntu:quantal"
1109 
+         ],
1110 
+         "ParentId": "27cf784147099545",
1111 
+         "Id": "b750fe79269d2ec9a3c593ef05b4332b1d1a02a62b4accb2c21d589ff2f5f2dc",
1112 
+         "Created": 1364102658,
1113 
+         "Size": 24653,
1114 
+         "VirtualSize": 180116135
1115 
+      }
1116 
+    ]
1117 1117
1118 1118 
 **Example request, with digest information**:
1119 1119
1120 
-        GET /images/json?digests=1 HTTP/1.1
1120 
+    GET /images/json?digests=1 HTTP/1.1
1121 1121
1122 1122 
 **Example response, with digest information**:
1123 1123
1124 
-        HTTP/1.1 200 OK
1125 
-        Content-Type: application/json
1124 
+    HTTP/1.1 200 OK
1125 
+    Content-Type: application/json
1126 1126
1127 
-        [
1128 
-          {
1129 
-            "Created": 1420064636,
1130 
-            "Id": "4986bf8c15363d1c5d15512d5266f8777bfba4974ac56e3270e7760f6f0a8125",
1131 
-            "ParentId": "ea13149945cb6b1e746bf28032f02e9b5a793523481a0a18645fc77ad53c4ea2",
1132 
-            "RepoDigests": [
1133 
-              "localhost:5000/test/busybox@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf"
1134 
-            ],
1135 
-            "RepoTags": [
1136 
-              "localhost:5000/test/busybox:latest",
1137 
-              "playdate:latest"
1138 
-            ],
1139 
-            "Size": 0,
1140 
-            "VirtualSize": 2429728
1141 
-          }
1142 
-        ]
1127 
+    [
1128 
+      {
1129 
+        "Created": 1420064636,
1130 
+        "Id": "4986bf8c15363d1c5d15512d5266f8777bfba4974ac56e3270e7760f6f0a8125",
1131 
+        "ParentId": "ea13149945cb6b1e746bf28032f02e9b5a793523481a0a18645fc77ad53c4ea2",
1132 
+        "RepoDigests": [
1133 
+          "localhost:5000/test/busybox@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf"
1134 
+        ],
1135 
+        "RepoTags": [
1136 
+          "localhost:5000/test/busybox:latest",
1137 
+          "playdate:latest"
1138 
+        ],
1139 
+        "Size": 0,
1140 
+        "VirtualSize": 2429728
1141 
+      }
1142 
+    ]
1143 1143
1144 1144 
 The response shows a single image `Id` associated with two repositories
1145 1145 
 (`RepoTags`): `localhost:5000/test/busybox`: and `playdate`. A caller can use
... ... 
@@ -1155,12 +1161,12 @@ digest. You can reference this digest using the value:
1155 1155 
 See the `docker run` and `docker build` commands for examples of digest and tag
1156 1156 
 references on the command line.
1157 1157
1158 
-Query Parameters:
1158 
+**Query parameters**:
1159 1159
1160 1160 
 -   **all** – 1/True/true or 0/False/false, default false
1161 
--   **filters** – a json encoded value of the filters (a map[string][]string) to process on the images list. Available filters:
1162 
-  -   dangling=true
1163 
-  -   label=`key` or `label="key=value"` of an image label
1161 
+-   **filters** – a JSON encoded value of the filters (a map[string][]string) to process on the images list. Available filters:
1162 
+  -   `dangling=true`
1163 
+  -   `label=key` or `label="key=value"` of an image label
1164 1164 
 -   **filter** - only return images with the specified name
1165 1165
1166 1166 
 ### Build image from a Dockerfile
... ... 
@@ -1171,37 +1177,37 @@ Build an image from a Dockerfile
1171 1171
1172 1172 
 **Example request**:
1173 1173
1174 
-        POST /build HTTP/1.1
1174 
+    POST /build HTTP/1.1
1175 1175
1176 
-        {{ TAR STREAM }}
1176 
+    {{ TAR STREAM }}
1177 1177
1178 1178 
 **Example response**:
1179 1179
1180 
-        HTTP/1.1 200 OK
1181 
-        Content-Type: application/json
1180 
+    HTTP/1.1 200 OK
1181 
+    Content-Type: application/json
1182 1182
1183 
-        {"stream": "Step 1..."}
1184 
-        {"stream": "..."}
1185 
-        {"error": "Error...", "errorDetail": {"code": 123, "message": "Error..."}}
1183 
+    {"stream": "Step 1..."}
1184 
+    {"stream": "..."}
1185 
+    {"error": "Error...", "errorDetail": {"code": 123, "message": "Error..."}}
1186 1186
1187 
-The input stream must be a tar archive compressed with one of the
1188 
-following algorithms: identity (no compression), gzip, bzip2, xz.
1187 
+The input stream must be a `tar` archive compressed with one of the
1188 
+following algorithms: `identity` (no compression), `gzip`, `bzip2`, `xz`.
1189 1189
1190 1190 
 The archive must include a build instructions file, typically called
1191 
-`Dockerfile` at the root of the archive. The `dockerfile` parameter may be
1192 
-used to specify a different build instructions file by having its value be
1191 
+`Dockerfile` at the archive's root. The `dockerfile` parameter may be
1192 
+used to specify a different build instructions file. To do this, its value must be
1193 1193 
 the path to the alternate build instructions file to use.
1194 1194
1195 1195 
 The archive may include any number of other files,
1196 
-which will be accessible in the build context (See the [*ADD build
1196 
+which are accessible in the build context (See the [*ADD build
1197 1197 
 command*](../../reference/builder.md#add)).
1198 1198
1199 
-The build will also be canceled if the client drops the connection by quitting
1199 
+The build is canceled if the client drops the connection by quitting
1200 1200 
 or being killed.
1201 1201
1202 
-Query Parameters:
1202 
+**Query parameters**:
1203 1203
1204 
--   **dockerfile** - path within the build context to the Dockerfile. This is
1204 
+-   **dockerfile** - Path within the build context to the Dockerfile. This is
1205 1205 
         ignored if `remote` is specified and points to an individual filename.
1206 1206 
 -   **t** – repository name (and optionally a tag) to be applied to
1207 1207 
         the resulting image in case of success
... ... 
@@ -1220,10 +1226,10 @@ Query Parameters:
1220 1220
1221 1221 
     Request Headers:
1222 1222
1223 
--   **Content-type** – should be set to `"application/tar"`.
1223 
+-   **Content-type** – Set to `"application/tar"`.
1224 1224 
 -   **X-Registry-Config** – base64-encoded ConfigFile object
1225 1225
1226 
-Status Codes:
1226 
+**Status codes**:
1227 1227
1228 1228 
 -   **200** – no error
1229 1229 
 -   **500** – server error
... ... 
@@ -1236,35 +1242,35 @@ Create an image, either by pulling it from the registry or by importing it
1236 1236
1237 1237 
 **Example request**:
1238 1238
1239 
-        POST /images/create?fromImage=ubuntu HTTP/1.1
1239 
+    POST /images/create?fromImage=ubuntu HTTP/1.1
1240 1240
1241 1241 
 **Example response**:
1242 1242
1243 
-        HTTP/1.1 200 OK
1244 
-        Content-Type: application/json
1243 
+    HTTP/1.1 200 OK
1244 
+    Content-Type: application/json
1245 1245
1246 
-        {"status": "Pulling..."}
1247 
-        {"status": "Pulling", "progress": "1 B/ 100 B", "progressDetail": {"current": 1, "total": 100}}
1248 
-        {"error": "Invalid..."}
1249 
-        ...
1246 
+    {"status": "Pulling..."}
1247 
+    {"status": "Pulling", "progress": "1 B/ 100 B", "progressDetail": {"current": 1, "total": 100}}
1248 
+    {"error": "Invalid..."}
1249 
+    ...
1250 1250
1251 
-    When using this endpoint to pull an image from the registry, the
1252 
-    `X-Registry-Auth` header can be used to include
1253 
-    a base64-encoded AuthConfig object.
1251 
+When using this endpoint to pull an image from the registry, the
1252 
+`X-Registry-Auth` header can be used to include
1253 
+a base64-encoded AuthConfig object.
1254 1254
1255 
-Query Parameters:
1255 
+**Query parameters**:
1256 1256
1257 
--   **fromImage** – name of the image to pull
1258 
--   **fromSrc** – source to import.  The value may be a URL from which the image
1257 
+-   **fromImage** – Name of the image to pull.
1258 
+-   **fromSrc** – Source to import.  The value may be a URL from which the image
1259 1259 
         can be retrieved or `-` to read the image from the request body.
1260 
--   **repo** – repository
1261 
--   **tag** – tag
1260 
+-   **repo** – Repository name.
1261 
+-   **tag** – Tag.
1262 1262
1263 1263 
     Request Headers:
1264 1264
1265 1265 
 -   **X-Registry-Auth** – base64-encoded AuthConfig object
1266 1266
1267 
-Status Codes:
1267 
+**Status codes**:
1268 1268
1269 1269 
 -   **200** – no error
1270 1270 
 -   **500** – server error
... ... 
@@ -1279,46 +1285,46 @@ Return low-level information on the image `name`
1279 1279
1280 1280 
 **Example request**:
1281 1281
1282 
-        GET /images/ubuntu/json HTTP/1.1
1282 
+    GET /images/ubuntu/json HTTP/1.1
1283 1283
1284 1284 
 **Example response**:
1285 1285
1286 
-        HTTP/1.1 200 OK
1287 
-        Content-Type: application/json
1286 
+    HTTP/1.1 200 OK
1287 
+    Content-Type: application/json
1288 1288
1289 
-        {
1290 
-             "Created": "2013-03-23T22:24:18.818426-07:00",
1291 
-             "Container": "3d67245a8d72ecf13f33dffac9f79dcdf70f75acb84d308770391510e0c23ad0",
1292 
-             "ContainerConfig":
1293 
-                     {
1294 
-                             "Hostname": "",
1295 
-                             "User": "",
1296 
-                             "AttachStdin": false,
1297 
-                             "AttachStdout": false,
1298 
-                             "AttachStderr": false,
1299 
-                             "PortSpecs": null,
1300 
-                             "Tty": true,
1301 
-                             "OpenStdin": true,
1302 
-                             "StdinOnce": false,
1303 
-                             "Env": null,
1304 
-                             "Cmd": ["/bin/bash"],
1305 
-                             "Dns": null,
1306 
-                             "Image": "ubuntu",
1307 
-                             "Labels": {
1308 
-                                 "com.example.vendor": "Acme",
1309 
-                                 "com.example.license": "GPL",
1310 
-                                 "com.example.version": "1.0"
1311 
-                             },
1312 
-                             "Volumes": null,
1313 
-                             "VolumesFrom": "",
1314 
-                             "WorkingDir": ""
1315 
-                     },
1316 
-             "Id": "b750fe79269d2ec9a3c593ef05b4332b1d1a02a62b4accb2c21d589ff2f5f2dc",
1317 
-             "Parent": "27cf784147099545",
1318 
-             "Size": 6824592
1319 
-        }
1289 
+    {
1290 
+         "Created": "2013-03-23T22:24:18.818426-07:00",
1291 
+         "Container": "3d67245a8d72ecf13f33dffac9f79dcdf70f75acb84d308770391510e0c23ad0",
1292 
+         "ContainerConfig":
1293 
+                 {
1294 
+                         "Hostname": "",
1295 
+                         "User": "",
1296 
+                         "AttachStdin": false,
1297 
+                         "AttachStdout": false,
1298 
+                         "AttachStderr": false,
1299 
+                         "PortSpecs": null,
1300 
+                         "Tty": true,
1301 
+                         "OpenStdin": true,
1302 
+                         "StdinOnce": false,
1303 
+                         "Env": null,
1304 
+                         "Cmd": ["/bin/bash"],
1305 
+                         "Dns": null,
1306 
+                         "Image": "ubuntu",
1307 
+                         "Labels": {
1308 
+                             "com.example.vendor": "Acme",
1309 
+                             "com.example.license": "GPL",
1310 
+                             "com.example.version": "1.0"
1311 
+                         },
1312 
+                         "Volumes": null,
1313 
+                         "VolumesFrom": "",
1314 
+                         "WorkingDir": ""
1315 
+                 },
1316 
+         "Id": "b750fe79269d2ec9a3c593ef05b4332b1d1a02a62b4accb2c21d589ff2f5f2dc",
1317 
+         "Parent": "27cf784147099545",
1318 
+         "Size": 6824592
1319 
+    }
1320 1320
1321 
-Status Codes:
1321 
+**Status codes**:
1322 1322
1323 1323 
 -   **200** – no error
1324 1324 
 -   **404** – no such image
... ... 
@@ -1332,27 +1338,27 @@ Return the history of the image `name`
1332 1332
1333 1333 
 **Example request**:
1334 1334
1335 
-        GET /images/ubuntu/history HTTP/1.1
1335 
+    GET /images/ubuntu/history HTTP/1.1
1336 1336
1337 1337 
 **Example response**:
1338 1338
1339 
-        HTTP/1.1 200 OK
1340 
-        Content-Type: application/json
1341 
-
1342 
-        [
1343 
-             {
1344 
-                     "Id": "b750fe79269d",
1345 
-                     "Created": 1364102658,
1346 
-                     "CreatedBy": "/bin/bash"
1347 
-             },
1348 
-             {
1349 
-                     "Id": "27cf78414709",
1350 
-                     "Created": 1364068391,
1351 
-                     "CreatedBy": ""
1352 
-             }
1353 
-        ]
1339 
+    HTTP/1.1 200 OK
1340 
+    Content-Type: application/json
1354 1341
1355 
-Status Codes:
1342 
+    [
1343 
+         {
1344 
+                 "Id": "b750fe79269d",
1345 
+                 "Created": 1364102658,
1346 
+                 "CreatedBy": "/bin/bash"
1347 
+         },
1348 
+         {
1349 
+                 "Id": "27cf78414709",
1350 
+                 "Created": 1364068391,
1351 
+                 "CreatedBy": ""
1352 
+         }
1353 
+    ]
1354 
+
1355 
+**Status codes**:
1356 1356
1357 1357 
 -   **200** – no error
1358 1358 
 -   **404** – no such image
... ... 
@@ -1366,37 +1372,37 @@ Push the image `name` on the registry
1366 1366
1367 1367 
 **Example request**:
1368 1368
1369 
-        POST /images/test/push HTTP/1.1
1369 
+    POST /images/test/push HTTP/1.1
1370 1370
1371 1371 
 **Example response**:
1372 1372
1373 
-        HTTP/1.1 200 OK
1374 
-        Content-Type: application/json
1373 
+    HTTP/1.1 200 OK
1374 
+    Content-Type: application/json
1375 1375
1376 
-        {"status": "Pushing..."}
1377 
-        {"status": "Pushing", "progress": "1/? (n/a)", "progressDetail": {"current": 1}}}
1378 
-        {"error": "Invalid..."}
1379 
-        ...
1376 
+    {"status": "Pushing..."}
1377 
+    {"status": "Pushing", "progress": "1/? (n/a)", "progressDetail": {"current": 1}}}
1378 
+    {"error": "Invalid..."}
1379 
+    ...
1380 1380
1381 
-    If you wish to push an image on to a private registry, that image must already have been tagged
1382 
-    into a repository which references that registry host name and port.  This repository name should
1383 
-    then be used in the URL. This mirrors the flow of the CLI.
1381 
+If you wish to push an image on to a private registry, that image must already have been tagged
1382 
+into a repository which references that registry host name and port.  This repository name should
1383 
+then be used in the URL. This mirrors the flow of the CLI.
1384 1384
1385 1385 
 **Example request**:
1386 1386
1387 
-        POST /images/registry.acme.com:5000/test/push HTTP/1.1
1387 
+    POST /images/registry.acme.com:5000/test/push HTTP/1.1
1388 1388
1389 1389
1390 
-Query Parameters:
1390 
+**Query parameters**:
1391 1391
1392 
--   **tag** – the tag to associate with the image on the registry, optional
1392 
+-   **tag** – The tag to associate with the image on the registry. This is optional.
1393 1393
1394 1394 
 Request Headers:
1395 1395
1396 
--   **X-Registry-Auth** – include a base64-encoded AuthConfig
1396 
+-   **X-Registry-Auth** – Include a base64-encoded AuthConfig.
1397 1397 
         object.
1398 1398
1399 
-Status Codes:
1399 
+**Status codes**:
1400 1400
1401 1401 
 -   **200** – no error
1402 1402 
 -   **404** – no such image
... ... 
@@ -1410,19 +1416,19 @@ Tag the image `name` into a repository
1410 1410
1411 1411 
 **Example request**:
1412 1412
1413 
-        POST /images/test/tag?repo=myrepo&force=0&tag=v42 HTTP/1.1
1413 
+    POST /images/test/tag?repo=myrepo&force=0&tag=v42 HTTP/1.1
1414 1414
1415 1415 
 **Example response**:
1416 1416
1417 
-        HTTP/1.1 201 Created
1417 
+    HTTP/1.1 201 Created
1418 1418
1419 
-Query Parameters:
1419 
+**Query parameters**:
1420 1420
1421 1421 
 -   **repo** – The repository to tag in
1422 1422 
 -   **force** – 1/True/true or 0/False/false, default false
1423 1423 
 -   **tag** - The new tag name
1424 1424
1425 
-Status Codes:
1425 
+**Status codes**:
1426 1426
1427 1427 
 -   **201** – no error
1428 1428 
 -   **400** – bad parameter
... ... 
@@ -1438,25 +1444,25 @@ Remove the image `name` from the filesystem
1438 1438
1439 1439 
 **Example request**:
1440 1440
1441 
-        DELETE /images/test HTTP/1.1
1441 
+    DELETE /images/test HTTP/1.1
1442 1442
1443 1443 
 **Example response**:
1444 1444
1445 
-        HTTP/1.1 200 OK
1446 
-        Content-type: application/json
1445 
+    HTTP/1.1 200 OK
1446 
+    Content-type: application/json
1447 1447
1448 
-        [
1449 
-         {"Untagged": "3e2f21a89f"},
1450 
-         {"Deleted": "3e2f21a89f"},
1451 
-         {"Deleted": "53b4f83ac9"}
1452 
-        ]
1448 
+    [
1449 
+     {"Untagged": "3e2f21a89f"},
1450 
+     {"Deleted": "3e2f21a89f"},
1451 
+     {"Deleted": "53b4f83ac9"}
1452 
+    ]
1453 1453
1454 
-Query Parameters:
1454 
+**Query parameters**:
1455 1455
1456 1456 
 -   **force** – 1/True/true or 0/False/false, default false
1457 1457 
 -   **noprune** – 1/True/true or 0/False/false, default false
1458 1458
1459 
-Status Codes:
1459 
+**Status codes**:
1460 1460
1461 1461 
 -   **200** – no error
1462 1462 
 -   **404** – no such image
... ... 
@@ -1475,43 +1481,43 @@ Search for an image on [Docker Hub](https://hub.docker.com).
1475 1475
1476 1476 
 **Example request**:
1477 1477
1478 
-        GET /images/search?term=sshd HTTP/1.1
1478 
+    GET /images/search?term=sshd HTTP/1.1
1479 1479
1480 1480 
 **Example response**:
1481 1481
1482 
-        HTTP/1.1 200 OK
1483 
-        Content-Type: application/json
1482 
+    HTTP/1.1 200 OK
1483 
+    Content-Type: application/json
1484 1484
1485 
-        [
1486 
-                {
1487 
-                    "description": "",
1488 
-                    "is_official": false,
1489 
-                    "is_automated": false,
1490 
-                    "name": "wma55/u1210sshd",
1491 
-                    "star_count": 0
1492 
-                },
1493 
-                {
1494 
-                    "description": "",
1495 
-                    "is_official": false,
1496 
-                    "is_automated": false,
1497 
-                    "name": "jdswinbank/sshd",
1498 
-                    "star_count": 0
1499 
-                },
1500 
-                {
1501 
-                    "description": "",
1502 
-                    "is_official": false,
1503 
-                    "is_automated": false,
1504 
-                    "name": "vgauthier/sshd",
1505 
-                    "star_count": 0
1506 
-                }
1507 
-        ...
1508 
-        ]
1485 
+    [
1486 
+            {
1487 
+                "description": "",
1488 
+                "is_official": false,
1489 
+                "is_automated": false,
1490 
+                "name": "wma55/u1210sshd",
1491 
+                "star_count": 0
1492 
+            },
1493 
+            {
1494 
+                "description": "",
1495 
+                "is_official": false,
1496 
+                "is_automated": false,
1497 
+                "name": "jdswinbank/sshd",
1498 
+                "star_count": 0
1499 
+            },
1500 
+            {
1501 
+                "description": "",
1502 
+                "is_official": false,
1503 
+                "is_automated": false,
1504 
+                "name": "vgauthier/sshd",
1505 
+                "star_count": 0
1506 
+            }
1507 
+    ...
1508 
+    ]
1509 1509
1510 
-Query Parameters:
1510 
+**Query parameters**:
1511 1511
1512 1512 
 -   **term** – term to search
1513 1513
1514 
-Status Codes:
1514 
+**Status codes**:
1515 1515
1516 1516 
 -   **200** – no error
1517 1517 
 -   **500** – server error
... ... 
@@ -1526,21 +1532,21 @@ Get the default username and email
1526 1526
1527 1527 
 **Example request**:
1528 1528
1529 
-        POST /auth HTTP/1.1
1530 
-        Content-Type: application/json
1529 
+    POST /auth HTTP/1.1
1530 
+    Content-Type: application/json
1531 1531
1532 
-        {
1533 
-             "username":" hannibal",
1534 
-             "password: "xxxx",
1535 
-             "email": "hannibal@a-team.com",
1536 
-             "serveraddress": "https://index.docker.io/v1/"
1537 
-        }
1532 
+    {
1533 
+         "username":" hannibal",
1534 
+         "password: "xxxx",
1535 
+         "email": "hannibal@a-team.com",
1536 
+         "serveraddress": "https://index.docker.io/v1/"
1537 
+    }
1538 1538
1539 1539 
 **Example response**:
1540 1540
1541 
-        HTTP/1.1 200 OK
1541 
+    HTTP/1.1 200 OK
1542 1542
1543 
-Status Codes:
1543 
+**Status codes**:
1544 1544
1545 1545 
 -   **200** – no error
1546 1546 
 -   **204** – no error
... ... 
@@ -1554,59 +1560,59 @@ Display system-wide information
1554 1554
1555 1555 
 **Example request**:
1556 1556
1557 
-        GET /info HTTP/1.1
1557 
+    GET /info HTTP/1.1
1558 1558
1559 1559 
 **Example response**:
1560 1560
1561 
-        HTTP/1.1 200 OK
1562 
-        Content-Type: application/json
1561 
+    HTTP/1.1 200 OK
1562 
+    Content-Type: application/json
1563 1563
1564 
-        {
1565 
-            "Containers": 11,
1566 
-            "Debug": 0,
1567 
-            "DockerRootDir": "/var/lib/docker",
1568 
-            "Driver": "btrfs",
1569 
-            "DriverStatus": [[""]],
1570 
-            "ExecutionDriver": "native-0.1",
1571 
-            "HttpProxy": "http://test:test@localhost:8080",
1572 
-            "HttpsProxy": "https://test:test@localhost:8080",
1573 
-            "ID": "7TRN:IPZB:QYBB:VPBQ:UMPP:KARE:6ZNR:XE6T:7EWV:PKF4:ZOJD:TPYS",
1574 
-            "IPv4Forwarding": 1,
1575 
-            "Images": 16,
1576 
-            "IndexServerAddress": "https://index.docker.io/v1/",
1577 
-            "InitPath": "/usr/bin/docker",
1578 
-            "InitSha1": "",
1579 
-            "KernelVersion": "3.12.0-1-amd64",
1580 
-            "Labels": [
1581 
-                "storage=ssd"
1582 
-            ],
1583 
-            "MemTotal": 2099236864,
1584 
-            "MemoryLimit": 1,
1585 
-            "NCPU": 1,
1586 
-            "NEventsListener": 0,
1587 
-            "NFd": 11,
1588 
-            "NGoroutines": 21,
1589 
-            "Name": "prod-server-42",
1590 
-            "NoProxy": "9.81.1.160",
1591 
-            "OperatingSystem": "Boot2Docker",
1592 
-            "RegistryConfig": {
1593 
-                "IndexConfigs": {
1594 
-                    "docker.io": {
1595 
-                        "Mirrors": null,
1596 
-                        "Name": "docker.io",
1597 
-                        "Official": true,
1598 
-                        "Secure": true
1599 
-                    }
1600 
-                },
1601 
-                "InsecureRegistryCIDRs": [
1602 
-                    "127.0.0.0/8"
1603 
-                ]
1564 
+    {
1565 
+        "Containers": 11,
1566 
+        "Debug": 0,
1567 
+        "DockerRootDir": "/var/lib/docker",
1568 
+        "Driver": "btrfs",
1569 
+        "DriverStatus": [[""]],
1570 
+        "ExecutionDriver": "native-0.1",
1571 
+        "HttpProxy": "http://test:test@localhost:8080",
1572 
+        "HttpsProxy": "https://test:test@localhost:8080",
1573 
+        "ID": "7TRN:IPZB:QYBB:VPBQ:UMPP:KARE:6ZNR:XE6T:7EWV:PKF4:ZOJD:TPYS",
1574 
+        "IPv4Forwarding": 1,
1575 
+        "Images": 16,
1576 
+        "IndexServerAddress": "https://index.docker.io/v1/",
1577 
+        "InitPath": "/usr/bin/docker",
1578 
+        "InitSha1": "",
1579 
+        "KernelVersion": "3.12.0-1-amd64",
1580 
+        "Labels": [
1581 
+            "storage=ssd"
1582 
+        ],
1583 
+        "MemTotal": 2099236864,
1584 
+        "MemoryLimit": 1,
1585 
+        "NCPU": 1,
1586 
+        "NEventsListener": 0,
1587 
+        "NFd": 11,
1588 
+        "NGoroutines": 21,
1589 
+        "Name": "prod-server-42",
1590 
+        "NoProxy": "9.81.1.160",
1591 
+        "OperatingSystem": "Boot2Docker",
1592 
+        "RegistryConfig": {
1593 
+            "IndexConfigs": {
1594 
+                "docker.io": {
1595 
+                    "Mirrors": null,
1596 
+                    "Name": "docker.io",
1597 
+                    "Official": true,
1598 
+                    "Secure": true
1599 
+                }
1604 1600 
             },
1605 
-            "SwapLimit": 0,
1606 
-            "SystemTime": "2015-03-10T11:11:23.730591467-07:00"
1607 
-        }
1601 
+            "InsecureRegistryCIDRs": [
1602 
+                "127.0.0.0/8"
1603 
+            ]
1604 
+        },
1605 
+        "SwapLimit": 0,
1606 
+        "SystemTime": "2015-03-10T11:11:23.730591467-07:00"
1607 
+    }
1608 1608
1609 
-Status Codes:
1609 
+**Status codes**:
1610 1610
1611 1611 
 -   **200** – no error
1612 1612 
 -   **500** – server error
... ... 
@@ -1619,24 +1625,24 @@ Show the docker version information
1619 1619
1620 1620 
 **Example request**:
1621 1621
1622 
-        GET /version HTTP/1.1
1622 
+    GET /version HTTP/1.1
1623 1623
1624 1624 
 **Example response**:
1625 1625
1626 
-        HTTP/1.1 200 OK
1627 
-        Content-Type: application/json
1626 
+    HTTP/1.1 200 OK
1627 
+    Content-Type: application/json
1628 1628
1629 
-        {
1630 
-             "Version": "1.5.0",
1631 
-             "Os": "linux",
1632 
-             "KernelVersion": "3.18.5-tinycore64",
1633 
-             "GoVersion": "go1.4.1",
1634 
-             "GitCommit": "a8a31ef",
1635 
-             "Arch": "amd64",
1636 
-             "ApiVersion": "1.18"
1637 
-        }
1629 
+    {
1630 
+         "Version": "1.5.0",
1631 
+         "Os": "linux",
1632 
+         "KernelVersion": "3.18.5-tinycore64",
1633 
+         "GoVersion": "go1.4.1",
1634 
+         "GitCommit": "a8a31ef",
1635 
+         "Arch": "amd64",
1636 
+         "ApiVersion": "1.18"
1637 
+    }
1638 1638
1639 
-Status Codes:
1639 
+**Status codes**:
1640 1640
1641 1641 
 -   **200** – no error
1642 1642 
 -   **500** – server error
... ... 
@@ -1649,16 +1655,16 @@ Ping the docker server
1649 1649
1650 1650 
 **Example request**:
1651 1651
1652 
-        GET /_ping HTTP/1.1
1652 
+    GET /_ping HTTP/1.1
1653 1653
1654 1654 
 **Example response**:
1655 1655
1656 
-        HTTP/1.1 200 OK
1657 
-        Content-Type: text/plain
1656 
+    HTTP/1.1 200 OK
1657 
+    Content-Type: text/plain
1658 1658
1659 
-        OK
1659 
+    OK
1660 1660
1661 
-Status Codes:
1661 
+**Status codes**:
1662 1662
1663 1663 
 -   **200** - no error
1664 1664 
 -   **500** - server error
... ... 
@@ -1671,46 +1677,46 @@ Create a new image from a container's changes
1671 1671
1672 1672 
 **Example request**:
1673 1673
1674 
-        POST /commit?container=44c004db4b17&comment=message&repo=myrepo HTTP/1.1
1675 
-        Content-Type: application/json
1674 
+    POST /commit?container=44c004db4b17&comment=message&repo=myrepo HTTP/1.1
1675 
+    Content-Type: application/json
1676 1676
1677 
-        {
1678 
-             "Hostname": "",
1679 
-             "Domainname": "",
1680 
-             "User": "",
1681 
-             "AttachStdin": false,
1682 
-             "AttachStdout": true,
1683 
-             "AttachStderr": true,
1684 
-             "PortSpecs": null,
1685 
-             "Tty": false,
1686 
-             "OpenStdin": false,
1687 
-             "StdinOnce": false,
1688 
-             "Env": null,
1689 
-             "Cmd": [
1690 
-                     "date"
1691 
-             ],
1692 
-             "Volumes": {
1693 
-                     "/tmp": {}
1694 
-             },
1695 
-             "WorkingDir": "",
1696 
-             "NetworkDisabled": false,
1697 
-             "ExposedPorts": {
1698 
-                     "22/tcp": {}
1699 
-             }
1700 
-        }
1677 
+    {
1678 
+         "Hostname": "",
1679 
+         "Domainname": "",
1680 
+         "User": "",
1681 
+         "AttachStdin": false,
1682 
+         "AttachStdout": true,
1683 
+         "AttachStderr": true,
1684 
+         "PortSpecs": null,
1685 
+         "Tty": false,
1686 
+         "OpenStdin": false,
1687 
+         "StdinOnce": false,
1688 
+         "Env": null,
1689 
+         "Cmd": [
1690 
+                 "date"
1691 
+         ],
1692 
+         "Volumes": {
1693 
+                 "/tmp": {}
1694 
+         },
1695 
+         "WorkingDir": "",
1696 
+         "NetworkDisabled": false,
1697 
+         "ExposedPorts": {
1698 
+                 "22/tcp": {}
1699 
+         }
1700 
+    }
1701 1701
1702 1702 
 **Example response**:
1703 1703
1704 
-        HTTP/1.1 201 Created
1705 
-        Content-Type: application/json
1704 
+    HTTP/1.1 201 Created
1705 
+    Content-Type: application/json
1706 1706
1707 
-        {"Id": "596069db4bf5"}
1707 
+    {"Id": "596069db4bf5"}
1708 1708
1709 
-Json Parameters:
1709 
+**JSON parameters**:
1710 1710
1711 1711 
 -  **config** - the container's configuration
1712 1712
1713 
-Query Parameters:
1713 
+**Query parameters**:
1714 1714
1715 1715 
 -   **container** – source container
1716 1716 
 -   **repo** – repository
... ... 
@@ -1719,7 +1725,7 @@ Query Parameters:
1719 1719 
 -   **author** – author (e.g., "John Hannibal Smith
1720 1720 
     <[hannibal@a-team.com](mailto:hannibal%40a-team.com)>")
1721 1721
1722 
-Status Codes:
1722 
+**Status codes**:
1723 1723
1724 1724 
 -   **201** – no error
1725 1725 
 -   **404** – no such container
... ... 
@@ -1732,38 +1738,38 @@ Status Codes:
1732 1732 
 Get container events from docker, either in real time via streaming, or via
1733 1733 
 polling (using since).
1734 1734
1735 
-Docker containers will report the following events:
1735 
+Docker containers report the following events:
1736 1736
1737 1737 
     create, destroy, die, exec_create, exec_start, export, kill, oom, pause, restart, start, stop, unpause
1738 1738
1739 
-and Docker images will report:
1739 
+and Docker images report:
1740 1740
1741 1741 
     untag, delete
1742 1742
1743 1743 
 **Example request**:
1744 1744
1745 
-        GET /events?since=1374067924
1745 
+    GET /events?since=1374067924
1746 1746
1747 1747 
 **Example response**:
1748 1748
1749 
-        HTTP/1.1 200 OK
1750 
-        Content-Type: application/json
1749 
+    HTTP/1.1 200 OK
1750 
+    Content-Type: application/json
1751 1751
1752 
-        {"status": "create", "id": "dfdf82bd3881","from": "ubuntu:latest", "time":1374067924}
1753 
-        {"status": "start", "id": "dfdf82bd3881","from": "ubuntu:latest", "time":1374067924}
1754 
-        {"status": "stop", "id": "dfdf82bd3881","from": "ubuntu:latest", "time":1374067966}
1755 
-        {"status": "destroy", "id": "dfdf82bd3881","from": "ubuntu:latest", "time":1374067970}
1752 
+    {"status": "create", "id": "dfdf82bd3881","from": "ubuntu:latest", "time":1374067924}
1753 
+    {"status": "start", "id": "dfdf82bd3881","from": "ubuntu:latest", "time":1374067924}
1754 
+    {"status": "stop", "id": "dfdf82bd3881","from": "ubuntu:latest", "time":1374067966}
1755 
+    {"status": "destroy", "id": "dfdf82bd3881","from": "ubuntu:latest", "time":1374067970}
1756 1756
1757 
-Query Parameters:
1757 
+**Query parameters**:
1758 1758
1759 
--   **since** – timestamp used for polling
1760 
--   **until** – timestamp used for polling
1761 
--   **filters** – a json encoded value of the filters (a map[string][]string) to process on the event list. Available filters:
1762 
-  -   event=&lt;string&gt; -- event to filter
1763 
-  -   image=&lt;string&gt; -- image to filter
1764 
-  -   container=&lt;string&gt; -- container to filter
1759 
+-   **since** – Timestamp used for polling
1760 
+-   **until** – Timestamp used for polling
1761 
+-   **filters** – A json encoded value of the filters (a map[string][]string) to process on the event list. Available filters:
1762 
+  -   `container=<string>`; -- container to filter
1763 
+  -   `event=<string>`; -- event to filter
1764 
+  -   `image=<string>`; -- image to filter
1765 1765
1766 
-Status Codes:
1766 
+**Status codes**:
1767 1767
1768 1768 
 -   **200** – no error
1769 1769 
 -   **500** – server error
... ... 
@@ -1784,16 +1790,16 @@ See the [image tarball format](#image-tarball-format) for more details.
1784 1784
1785 1785 
 **Example request**
1786 1786
1787 
-        GET /images/ubuntu/get
1787 
+    GET /images/ubuntu/get
1788 1788
1789 1789 
 **Example response**:
1790 1790
1791 
-        HTTP/1.1 200 OK
1792 
-        Content-Type: application/x-tar
1791 
+    HTTP/1.1 200 OK
1792 
+    Content-Type: application/x-tar
1793 1793
1794 
-        Binary data stream
1794 
+    Binary data stream
1795 1795
1796 
-Status Codes:
1796 
+**Status codes**:
1797 1797
1798 1798 
 -   **200** – no error
1799 1799 
 -   **500** – server error
... ... 
@@ -1805,7 +1811,7 @@ Status Codes:
1805 1805 
 Get a tarball containing all images and metadata for one or more repositories.
1806 1806
1807 1807 
 For each value of the `names` parameter: if it is a specific name and tag (e.g.
1808 
-ubuntu:latest), then only that image (and its parents) are returned; if it is
1808 
+`ubuntu:latest`), then only that image (and its parents) are returned; if it is
1809 1809 
 an image ID, similarly only that image (and its parents) are returned and there
1810 1810 
 would be no names referenced in the 'repositories' file for this image ID.
1811 1811
... ... 
@@ -1813,16 +1819,16 @@ See the [image tarball format](#image-tarball-format) for more details.
1813 1813
1814 1814 
 **Example request**
1815 1815
1816 
-        GET /images/get?names=myname%2Fmyapp%3Alatest&names=busybox
1816 
+    GET /images/get?names=myname%2Fmyapp%3Alatest&names=busybox
1817 1817
1818 1818 
 **Example response**:
1819 1819
1820 
-        HTTP/1.1 200 OK
1821 
-        Content-Type: application/x-tar
1820 
+    HTTP/1.1 200 OK
1821 
+    Content-Type: application/x-tar
1822 1822
1823 
-        Binary data stream
1823 
+    Binary data stream
1824 1824
1825 
-Status Codes:
1825 
+**Status codes**:
1826 1826
1827 1827 
 -   **200** – no error
1828 1828 
 -   **500** – server error
... ... 
@@ -1831,20 +1837,20 @@ Status Codes:
1831 1831
1832 1832 
 `POST /images/load`
1833 1833
1834 
-Load a set of images and tags into the docker repository.
1834 
+Load a set of images and tags into a Docker repository.
1835 1835 
 See the [image tarball format](#image-tarball-format) for more details.
1836 1836
1837 1837 
 **Example request**
1838 1838
1839 
-        POST /images/load
1839 
+    POST /images/load
1840 1840
1841 
-        Tarball in body
1841 
+    Tarball in body
1842 1842
1843 1843 
 **Example response**:
1844 1844
1845 
-        HTTP/1.1 200 OK
1845 
+    HTTP/1.1 200 OK
1846 1846
1847 
-Status Codes:
1847 
+**Status codes**:
1848 1848
1849 1849 
 -   **200** – no error
1850 1850 
 -   **500** – server error
... ... 
@@ -1852,16 +1858,16 @@ Status Codes:
1852 1852 
 ### Image tarball format
1853 1853
1854 1854 
 An image tarball contains one directory per image layer (named using its long ID),
1855 
-each containing three files:
1855 
+each containing these files:
1856 1856
1857 
-1. `VERSION`: currently `1.0` - the file format version
1858 
-2. `json`: detailed layer information, similar to `docker inspect layer_id`
1859 
-3. `layer.tar`: A tarfile containing the filesystem changes in this layer
1857 
+- `VERSION`: currently `1.0` - the file format version
1858 
+- `json`: detailed layer information, similar to `docker inspect layer_id`
1859 
+- `layer.tar`: A tarfile containing the filesystem changes in this layer
1860 1860
1861 
-The `layer.tar` file will contain `aufs` style `.wh..wh.aufs` files and directories
1861 
+The `layer.tar` file contains `aufs` style `.wh..wh.aufs` files and directories
1862 1862 
 for storing attribute changes and deletions.
1863 1863
1864 
-If the tarball defines a repository, there will also be a `repositories` file at
1864 
+If the tarball defines a repository, the tarball should also include a `repositories` file at
1865 1865 
 the root that contains a list of repository and tag names mapped to layer IDs.
1866 1866
1867 1867 
 ```
... ... 
@@ -1878,39 +1884,39 @@ Sets up an exec instance in a running container `id`
1878 1878
1879 1879 
 **Example request**:
1880 1880
1881 
-        POST /containers/e90e34656806/exec HTTP/1.1
1882 
-        Content-Type: application/json
1881 
+    POST /containers/e90e34656806/exec HTTP/1.1
1882 
+    Content-Type: application/json
1883 1883
1884 
-        {
1885 
-	     "AttachStdin": false,
1886 
-	     "AttachStdout": true,
1887 
-	     "AttachStderr": true,
1888 
-	     "Tty": false,
1889 
-	     "Cmd": [
1884 
+      {
1885 
+       "AttachStdin": false,
1886 
+       "AttachStdout": true,
1887 
+       "AttachStderr": true,
1888 
+       "Tty": false,
1889 
+       "Cmd": [
1890 1890 
                      "date"
1891 
-             ],
1892 
-        }
1891 
+             ]
1892 
+      }
1893 1893
1894 1894 
 **Example response**:
1895 1895
1896 
-        HTTP/1.1 201 Created
1897 
-        Content-Type: application/json
1896 
+    HTTP/1.1 201 Created
1897 
+    Content-Type: application/json
1898 1898
1899 
-        {
1900 
-             "Id": "f90e34656806",
1901 
-             "Warnings":[]
1902 
-        }
1899 
+    {
1900 
+         "Id": "f90e34656806",
1901 
+         "Warnings":[]
1902 
+    }
1903 1903
1904 
-Json Parameters:
1904 
+**JSON parameters**:
1905 1905
1906 
--   **AttachStdin** - Boolean value, attaches to stdin of the exec command.
1907 
--   **AttachStdout** - Boolean value, attaches to stdout of the exec command.
1908 
--   **AttachStderr** - Boolean value, attaches to stderr of the exec command.
1909 
--   **Tty** - Boolean value to allocate a pseudo-TTY
1906 
+-   **AttachStdin** - Boolean value, attaches to `stdin` of the `exec` command.
1907 
+-   **AttachStdout** - Boolean value, attaches to `stdout` of the `exec` command.
1908 
+-   **AttachStderr** - Boolean value, attaches to `stderr` of the `exec` command.
1909 
+-   **Tty** - Boolean value to allocate a pseudo-TTY.
1910 1910 
 -   **Cmd** - Command to run specified as a string or an array of strings.
1911 1911
1912 1912
1913 
-Status Codes:
1913 
+**Status codes**:
1914 1914
1915 1915 
 -   **201** – no error
1916 1916 
 -   **404** – no such container
... ... 
@@ -1919,33 +1925,33 @@ Status Codes:
1919 1919
1920 1920 
 `POST /exec/(id)/start`
1921 1921
1922 
-Starts a previously set up exec instance `id`. If `detach` is true, this API
1922 
+Starts a previously set up `exec` instance `id`. If `detach` is true, this API
1923 1923 
 returns after starting the `exec` command. Otherwise, this API sets up an
1924 1924 
 interactive session with the `exec` command.
1925 1925
1926 1926 
 **Example request**:
1927 1927
1928 
-        POST /exec/e90e34656806/start HTTP/1.1
1929 
-        Content-Type: application/json
1928 
+    POST /exec/e90e34656806/start HTTP/1.1
1929 
+    Content-Type: application/json
1930 1930
1931 
-        {
1932 
-	     "Detach": false,
1933 
-	     "Tty": false,
1934 
-        }
1931 
+    {
1932 
+     "Detach": false,
1933 
+     "Tty": false
1934 
+    }
1935 1935
1936 1936 
 **Example response**:
1937 1937
1938 
-        HTTP/1.1 200 OK
1939 
-        Content-Type: application/vnd.docker.raw-stream
1938 
+    HTTP/1.1 200 OK
1939 
+    Content-Type: application/vnd.docker.raw-stream
1940 1940
1941 
-        {{ STREAM }}
1941 
+    {{ STREAM }}
1942 1942
1943 
-Json Parameters:
1943 
+**JSON parameters**:
1944 1944
1945 
--   **Detach** - Detach from the exec command
1946 
--   **Tty** - Boolean value to allocate a pseudo-TTY
1945 
+-   **Detach** - Detach from the `exec` command.
1946 
+-   **Tty** - Boolean value to allocate a pseudo-TTY.
1947 1947
1948 
-Status Codes:
1948 
+**Status codes**:
1949 1949
1950 1950 
 -   **200** – no error
1951 1951 
 -   **404** – no such exec instance
... ... 
@@ -1957,25 +1963,25 @@ Status Codes:
1957 1957
1958 1958 
 `POST /exec/(id)/resize`
1959 1959
1960 
-Resizes the tty session used by the exec command `id`.
1961 
-This API is valid only if `tty` was specified as part of creating and starting the exec command.
1960 
+Resizes the `tty` session used by the `exec` command `id`.  The unit is number of characters.
1961 
+This API is valid only if `tty` was specified as part of creating and starting the `exec` command.
1962 1962
1963 1963 
 **Example request**:
1964 1964
1965 
-        POST /exec/e90e34656806/resize HTTP/1.1
1966 
-        Content-Type: text/plain
1965 
+    POST /exec/e90e34656806/resize?h=40&w=80 HTTP/1.1
1966 
+    Content-Type: text/plain
1967 1967
1968 1968 
 **Example response**:
1969 1969
1970 
-        HTTP/1.1 201 Created
1971 
-        Content-Type: text/plain
1970 
+    HTTP/1.1 201 Created
1971 
+    Content-Type: text/plain
1972 1972
1973 
-Query Parameters:
1973 
+**Query parameters**:
1974 1974
1975 
--   **h** – height of tty session
1975 
+-   **h** – height of `tty` session
1976 1976 
 -   **w** – width
1977 1977
1978 
-Status Codes:
1978 
+**Status codes**:
1979 1979
1980 1980 
 -   **201** – no error
1981 1981 
 -   **404** – no such exec instance
... ... 
@@ -1984,102 +1990,102 @@ Status Codes:
1984 1984
1985 1985 
 `GET /exec/(id)/json`
1986 1986
1987 
-Return low-level information about the exec command `id`.
1987 
+Return low-level information about the `exec` command `id`.
1988 1988
1989 1989 
 **Example request**:
1990 1990
1991 
-        GET /exec/11fb006128e8ceb3942e7c58d77750f24210e35f879dd204ac975c184b820b39/json HTTP/1.1
1991 
+    GET /exec/11fb006128e8ceb3942e7c58d77750f24210e35f879dd204ac975c184b820b39/json HTTP/1.1
1992 1992
1993 1993 
 **Example response**:
1994 1994
1995 
-        HTTP/1.1 200 OK
1996 
-        Content-Type: plain/text
1995 
+    HTTP/1.1 200 OK
1996 
+    Content-Type: plain/text
1997 1997
1998 
-        {
1999 
-          "ID" : "11fb006128e8ceb3942e7c58d77750f24210e35f879dd204ac975c184b820b39",
2000 
-          "Running" : false,
2001 
-          "ExitCode" : 2,
2002 
-          "ProcessConfig" : {
2003 
-            "privileged" : false,
2004 
-            "user" : "",
2005 
-            "tty" : false,
2006 
-            "entrypoint" : "sh",
2007 
-            "arguments" : [
2008 
-              "-c",
2009 
-              "exit 2"
2010 
-            ]
2011 
-          },
1998 
+    {
1999 
+      "ID" : "11fb006128e8ceb3942e7c58d77750f24210e35f879dd204ac975c184b820b39",
2000 
+      "Running" : false,
2001 
+      "ExitCode" : 2,
2002 
+      "ProcessConfig" : {
2003 
+        "privileged" : false,
2004 
+        "user" : "",
2005 
+        "tty" : false,
2006 
+        "entrypoint" : "sh",
2007 
+        "arguments" : [
2008 
+          "-c",
2009 
+          "exit 2"
2010 
+        ]
2011 
+      },
2012 
+      "OpenStdin" : false,
2013 
+      "OpenStderr" : false,
2014 
+      "OpenStdout" : false,
2015 
+      "Container" : {
2016 
+        "State" : {
2017 
+          "Running" : true,
2018 
+          "Paused" : false,
2019 
+          "Restarting" : false,
2020 
+          "OOMKilled" : false,
2021 
+          "Pid" : 3650,
2022 
+          "ExitCode" : 0,
2023 
+          "Error" : "",
2024 
+          "StartedAt" : "2014-11-17T22:26:03.717657531Z",
2025 
+          "FinishedAt" : "0001-01-01T00:00:00Z"
2026 
+        },
2027 
+        "ID" : "8f177a186b977fb451136e0fdf182abff5599a08b3c7f6ef0d36a55aaf89634c",
2028 
+        "Created" : "2014-11-17T22:26:03.626304998Z",
2029 
+        "Path" : "date",
2030 
+        "Args" : [],
2031 
+        "Config" : {
2032 
+          "Hostname" : "8f177a186b97",
2033 
+          "Domainname" : "",
2034 
+          "User" : "",
2035 
+          "AttachStdin" : false,
2036 
+          "AttachStdout" : false,
2037 
+          "AttachStderr" : false,
2038 
+          "PortSpecs": null,
2039 
+          "ExposedPorts" : null,
2040 
+          "Tty" : false,
2012 2041 
           "OpenStdin" : false,
2013 
-          "OpenStderr" : false,
2014 
-          "OpenStdout" : false,
2015 
-          "Container" : {
2016 
-            "State" : {
2017 
-              "Running" : true,
2018 
-              "Paused" : false,
2019 
-              "Restarting" : false,
2020 
-              "OOMKilled" : false,
2021 
-              "Pid" : 3650,
2022 
-              "ExitCode" : 0,
2023 
-              "Error" : "",
2024 
-              "StartedAt" : "2014-11-17T22:26:03.717657531Z",
2025 
-              "FinishedAt" : "0001-01-01T00:00:00Z"
2026 
-            },
2027 
-            "ID" : "8f177a186b977fb451136e0fdf182abff5599a08b3c7f6ef0d36a55aaf89634c",
2028 
-            "Created" : "2014-11-17T22:26:03.626304998Z",
2029 
-            "Path" : "date",
2030 
-            "Args" : [],
2031 
-            "Config" : {
2032 
-              "Hostname" : "8f177a186b97",
2033 
-              "Domainname" : "",
2034 
-              "User" : "",
2035 
-              "AttachStdin" : false,
2036 
-              "AttachStdout" : false,
2037 
-              "AttachStderr" : false,
2038 
-              "PortSpecs" : null,
2039 
-              "ExposedPorts" : null,
2040 
-              "Tty" : false,
2041 
-              "OpenStdin" : false,
2042 
-              "StdinOnce" : false,
2043 
-              "Env" : [ "PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin" ],
2044 
-              "Cmd" : [
2045 
-                "date"
2046 
-              ],
2047 
-              "Image" : "ubuntu",
2048 
-              "Volumes" : null,
2049 
-              "WorkingDir" : "",
2050 
-              "Entrypoint" : null,
2051 
-              "NetworkDisabled" : false,
2052 
-              "MacAddress" : "",
2053 
-              "OnBuild" : null,
2054 
-              "SecurityOpt" : null
2055 
-            },
2056 
-            "Image" : "5506de2b643be1e6febbf3b8a240760c6843244c41e12aa2f60ccbb7153d17f5",
2057 
-            "NetworkSettings" : {
2058 
-              "IPAddress" : "172.17.0.2",
2059 
-              "IPPrefixLen" : 16,
2060 
-              "MacAddress" : "02:42:ac:11:00:02",
2061 
-              "Gateway" : "172.17.42.1",
2062 
-              "Bridge" : "docker0",
2063 
-              "PortMapping" : null,
2064 
-              "Ports" : {}
2065 
-            },
2066 
-            "ResolvConfPath" : "/var/lib/docker/containers/8f177a186b977fb451136e0fdf182abff5599a08b3c7f6ef0d36a55aaf89634c/resolv.conf",
2067 
-            "HostnamePath" : "/var/lib/docker/containers/8f177a186b977fb451136e0fdf182abff5599a08b3c7f6ef0d36a55aaf89634c/hostname",
2068 
-            "HostsPath" : "/var/lib/docker/containers/8f177a186b977fb451136e0fdf182abff5599a08b3c7f6ef0d36a55aaf89634c/hosts",
2069 
-            "LogPath": "/var/lib/docker/containers/1eb5fabf5a03807136561b3c00adcd2992b535d624d5e18b6cdc6a6844d9767b/1eb5fabf5a03807136561b3c00adcd2992b535d624d5e18b6cdc6a6844d9767b-json.log",
2070 
-            "Name" : "/test",
2071 
-            "Driver" : "aufs",
2072 
-            "ExecDriver" : "native-0.2",
2073 
-            "MountLabel" : "",
2074 
-            "ProcessLabel" : "",
2075 
-            "AppArmorProfile" : "",
2076 
-            "RestartCount" : 0,
2077 
-            "Volumes" : {},
2078 
-            "VolumesRW" : {}
2079 
-          }
2080 
-        }
2042 
+          "StdinOnce" : false,
2043 
+          "Env" : [ "PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin" ],
2044 
+          "Cmd" : [
2045 
+            "date"
2046 
+          ],
2047 
+          "Image" : "ubuntu",
2048 
+          "Volumes" : null,
2049 
+          "WorkingDir" : "",
2050 
+          "Entrypoint" : null,
2051 
+          "NetworkDisabled" : false,
2052 
+          "MacAddress" : "",
2053 
+          "OnBuild" : null,
2054 
+          "SecurityOpt" : null
2055 
+        },
2056 
+        "Image" : "5506de2b643be1e6febbf3b8a240760c6843244c41e12aa2f60ccbb7153d17f5",
2057 
+        "NetworkSettings" : {
2058 
+          "IPAddress" : "172.17.0.2",
2059 
+          "IPPrefixLen" : 16,
2060 
+          "MacAddress" : "02:42:ac:11:00:02",
2061 
+          "Gateway" : "172.17.42.1",
2062 
+          "Bridge" : "docker0",
2063 
+          "PortMapping" : null,
2064 
+          "Ports" : {}
2065 
+        },
2066 
+        "ResolvConfPath" : "/var/lib/docker/containers/8f177a186b977fb451136e0fdf182abff5599a08b3c7f6ef0d36a55aaf89634c/resolv.conf",
2067 
+        "HostnamePath" : "/var/lib/docker/containers/8f177a186b977fb451136e0fdf182abff5599a08b3c7f6ef0d36a55aaf89634c/hostname",
2068 
+        "HostsPath" : "/var/lib/docker/containers/8f177a186b977fb451136e0fdf182abff5599a08b3c7f6ef0d36a55aaf89634c/hosts",
2069 
+        "LogPath": "/var/lib/docker/containers/1eb5fabf5a03807136561b3c00adcd2992b535d624d5e18b6cdc6a6844d9767b/1eb5fabf5a03807136561b3c00adcd2992b535d624d5e18b6cdc6a6844d9767b-json.log",
2070 
+        "Name" : "/test",
2071 
+        "Driver" : "aufs",
2072 
+        "ExecDriver" : "native-0.2",
2073 
+        "MountLabel" : "",
2074 
+        "ProcessLabel" : "",
2075 
+        "AppArmorProfile" : "",
2076 
+        "RestartCount" : 0,
2077 
+        "Volumes" : {},
2078 
+        "VolumesRW" : {}
2079 
+      }
2080 
+    }
2081 2081
2082 
-Status Codes:
2082 
+**Status codes**:
2083 2083
2084 2084 
 -   **200** – no error
2085 2085 
 -   **404** – no such exec instance
... ... 
@@ -2094,22 +2100,21 @@ As an example, the `docker run` command line makes the following API calls:
2094 2094 
 - Create the container
2095 2095
2096 2096 
 - If the status code is 404, it means the image doesn't exist:
2097 
-    - Try to pull it
2098 
-    - Then retry to create the container
2097 
+    - Try to pull it.
2098 
+    - Then, retry to create the container.
2099 2099
2100 
-- Start the container
2100 
+- Start the container.
2101 2101
2102 2102 
 - If you are not in detached mode:
2103 
-- Attach to the container, using logs=1 (to have stdout and
2104 
-      stderr from the container's start) and stream=1
2103 
+- Attach to the container, using `logs=1` (to have `stdout` and
2104 
+      `stderr` from the container's start) and `stream=1`
2105 2105
2106 
-- If in detached mode or only stdin is attached:
2107 
-- Display the container's id
2106 
+- If in detached mode or only `stdin` is attached, display the container's id.
2108 2107
2109 2108 
 ## 3.2 Hijacking
2110 2109
2111 
-In this version of the API, /attach, uses hijacking to transport stdin,
2112 
-stdout and stderr on the same socket.
2110 
+In this version of the API, `/attach`, uses hijacking to transport `stdin`,
2111 
+`stdout`, and `stderr` on the same socket.
2113 2112
2114 2113 
 To hint potential proxies about connection hijacking, Docker client sends
2115 2114 
 connection upgrade headers similarly to websocket.
... ... 
@@ -2117,15 +2122,15 @@ connection upgrade headers similarly to websocket.
2117 2117 
     Upgrade: tcp
2118 2118 
     Connection: Upgrade
2119 2119
2120 
-When Docker daemon detects the `Upgrade` header, it will switch its status code
2121 
-from **200 OK** to **101 UPGRADED** and resend the same headers.
2120 
+When Docker daemon detects the `Upgrade` header, it switches its status code
2121 
+from **200 OK** to **101 UPGRADED** and resends the same headers.
2122 2122
2123 2123 
 This might change in the future.
2124 2124
2125 2125 
 ## 3.3 CORS Requests
2126 2126
2127 2127 
 To set cross origin requests to the remote api please give values to
2128 
-"--api-cors-header" when running docker in daemon mode. Set * will allow all,
2128 
+`--api-cors-header` when running Docker in daemon mode. Set * (asterisk) allows all,
2129 2129 
 default or blank means CORS disabled
2130 2130
2131 2131 
     $ docker -d -H="192.168.1.9:2375" --api-cors-header="http://foo.bar"
docs/reference/api/docker_remote_api_v1.19.md
History View file @ 0194094
... ... 
@@ -96,7 +96,7 @@ List containers
96 96 
          }
97 97 
     ]
98 98
99 
-Query Parameters:
99 
+**Query parameters**:
100 100
101 101 
 -   **all** – 1/True/true or 0/False/false, Show all containers.
102 102 
         Only running containers are shown by default (i.e., this defaults to false)
... ... 
@@ -113,7 +113,7 @@ Query Parameters:
113 113 
   -   `status=`(`restarting`|`running`|`paused`|`exited`)
114 114 
   -   `label=key` or `label="key=value"` of a container label
115 115
116 
-Status Codes:
116 
+**Status codes**:
117 117
118 118 
 -   **200** – no error
119 119 
 -   **400** – bad parameter
... ... 
@@ -155,7 +155,7 @@ Create a container
155 155 
                    "com.example.version": "1.0"
156 156 
            },
157 157 
            "Volumes": {
158 
-                   "/tmp": {}
158 
+             "/volumes/data": {}
159 159 
            },
160 160 
            "WorkingDir": "",
161 161 
            "NetworkDisabled": false,
... ... 
@@ -207,7 +207,7 @@ Create a container
207 207 
            "Warnings":[]
208 208 
       }
209 209
210 
-Json Parameters:
210 
+**JSON parameters**:
211 211
212 212 
 -   **Hostname** - A string value containing the hostname to use for the
213 213 
       container.
... ... 
@@ -226,7 +226,7 @@ Json Parameters:
226 226 
 -   **Entrypoint** - Set the entry point for the container as a string or an array
227 227 
       of strings.
228 228 
 -   **Image** - A string specifying the image name to use for the container.
229 
--   **Volumes** – An object mapping mount point paths (strings) inside the
229 
+-   **Volumes** - An object mapping mount point paths (strings) inside the
230 230 
       container to empty objects.
231 231 
 -   **WorkingDir** - A string specifying the working directory for commands to
232 232 
       run in.
... ... 
@@ -296,15 +296,15 @@ Json Parameters:
296 296 
     -   **LogConfig** - Log configuration for the container, specified as a JSON object in the form
297 297 
           `{ "Type": "<driver_name>", "Config": {"key1": "val1"}}`.
298 298 
           Available types: `json-file`, `syslog`, `journald`, `none`.
299 
-	      `syslog` available options are: `address`.
300 
-    -   **CgroupParent** - Path to cgroups under which the cgroup for the container will be created. If the path is not absolute, the path is considered to be relative to the cgroups path of the init process. Cgroups will be created if they do not already exist.
299 
+          `syslog` available options are: `address`.
300 
+    -   **CgroupParent** - Path to `cgroups` under which the container's `cgroup` is created. If the path is not absolute, the path is considered to be relative to the `cgroups` path of the init process. Cgroups are created if they do not already exist.
301 301
302 
-Query Parameters:
302 
+**Query parameters**:
303 303
304 304 
 -   **name** – Assign the specified name to the container. Must
305 305 
     match `/?[a-zA-Z0-9_-]+`.
306 306
307 
-Status Codes:
307 
+**Status codes**:
308 308
309 309 
 -   **201** – no error
310 310 
 -   **400** – bad parameter
... ... 
@@ -319,7 +319,6 @@ Status Codes:
319 319
320 320 
 Return low-level information on the container `id`
321 321
322 
-
323 322 
 **Example request**:
324 323
325 324 
       GET /containers/4fa6e0f0c678/json HTTP/1.1
... ... 
@@ -445,7 +444,7 @@ Return low-level information on the container `id`
445 445 
 		"VolumesRW": {}
446 446 
 	}
447 447
448 
-Status Codes:
448 
+**Status codes**:
449 449
450 450 
 -   **200** – no error
451 451 
 -   **404** – no such container
... ... 
@@ -505,11 +504,11 @@ supported on Windows.
505 505 
       ],
506 506 
     }
507 507
508 
-Query Parameters:
508 
+**Query parameters**:
509 509
510 510 
 -   **ps_args** – `ps` arguments to use (e.g., `aux`), defaults to `-ef`
511 511
512 
-Status Codes:
512 
+**Status codes**:
513 513
514 514 
 -   **200** – no error
515 515 
 -   **404** – no such container
... ... 
@@ -537,7 +536,7 @@ Get `stdout` and `stderr` logs from the container ``id``
537 537
538 538 
      {{ STREAM }}
539 539
540 
-Query Parameters:
540 
+**Query parameters**:
541 541
542 542 
 -   **follow** – 1/True/true or 0/False/false, return stream. Default `false`.
543 543 
 -   **stdout** – 1/True/true or 0/False/false, show `stdout` log. Default `false`.
... ... 
@@ -548,7 +547,7 @@ Query Parameters:
548 548 
         every log line. Default `false`.
549 549 
 -   **tail** – Output specified number of lines at the end of logs: `all` or `<number>`. Default all.
550 550
551 
-Status Codes:
551 
+**Status codes**:
552 552
553 553 
 -   **101** – no error, hints proxy about hijacking
554 554 
 -   **200** – no error, no upgrade header found
... ... 
@@ -591,7 +590,7 @@ Values for `Kind`:
591 591 
 - `1`: Add
592 592 
 - `2`: Delete
593 593
594 
-Status Codes:
594 
+**Status codes**:
595 595
596 596 
 -   **200** – no error
597 597 
 -   **404** – no such container
... ... 
@@ -614,7 +613,7 @@ Export the contents of container `id`
614 614
615 615 
     {{ TAR STREAM }}
616 616
617 
-Status Codes:
617 
+**Status codes**:
618 618
619 619 
 -   **200** – no error
620 620 
 -   **404** – no such container
... ... 
@@ -719,11 +718,11 @@ This endpoint returns a live stream of a container's resource usage statistics.
719 719
720 720 
 The precpu_stats is the cpu statistic of last read, which is used for calculating the cpu usage percent. It is not the exact copy of the “cpu_stats” field.
721 721
722 
-Query Parameters:
722 
+**Query parameters**:
723 723
724 724 
 -   **stream** – 1/True/true or 0/False/false, pull stats once then disconnect. Default `true`.
725 725
726 
-Status Codes:
726 
+**Status codes**:
727 727
728 728 
 -   **200** – no error
729 729 
 -   **404** – no such container
... ... 
@@ -745,7 +744,12 @@ Resize the TTY for container with  `id`. You must restart the container for the
745 745 
       Content-Length: 0
746 746 
       Content-Type: text/plain; charset=utf-8
747 747
748 
-Status Codes:
748 
+**Query parameters**:
749 
+
750 
+-   **h** – height of `tty` session
751 
+-   **w** – width
752 
+
753 
+**Status codes**:
749 754
750 755 
 -   **200** – no error
751 756 
 -   **404** – No such container
... ... 
@@ -763,13 +767,13 @@ Start the container `id`
763 763
764 764 
 **Example request**:
765 765
766 
-     POST /containers/e90e34656806/start HTTP/1.1
766 
+    POST /containers/e90e34656806/start HTTP/1.1
767 767
768 768 
 **Example response**:
769 769
770 
-     HTTP/1.1 204 No Content
770 
+    HTTP/1.1 204 No Content
771 771
772 
-Status Codes:
772 
+**Status codes**:
773 773
774 774 
 -   **204** – no error
775 775 
 -   **304** – container already started
... ... 
@@ -790,11 +794,11 @@ Stop the container `id`
790 790
791 791 
     HTTP/1.1 204 No Content
792 792
793 
-Query Parameters:
793 
+**Query parameters**:
794 794
795 795 
 -   **t** – number of seconds to wait before killing the container
796 796
797 
-Status Codes:
797 
+**Status codes**:
798 798
799 799 
 -   **204** – no error
800 800 
 -   **304** – container already stopped
... ... 
@@ -815,11 +819,11 @@ Restart the container `id`
815 815
816 816 
     HTTP/1.1 204 No Content
817 817
818 
-Query Parameters:
818 
+**Query parameters**:
819 819
820 820 
 -   **t** – number of seconds to wait before killing the container
821 821
822 
-Status Codes:
822 
+**Status codes**:
823 823
824 824 
 -   **204** – no error
825 825 
 -   **404** – no such container
... ... 
@@ -839,12 +843,12 @@ Kill the container `id`
839 839
840 840 
     HTTP/1.1 204 No Content
841 841
842 
-Query Parameters
842 
+**Query parameters**:
843 843
844 844 
 -   **signal** - Signal to send to the container: integer or string like `SIGINT`.
845 845 
         When not set, `SIGKILL` is assumed and the call waits for the container to exit.
846 846
847 
-Status Codes:
847 
+**Status codes**:
848 848
849 849 
 -   **204** – no error
850 850 
 -   **404** – no such container
... ... 
@@ -864,11 +868,11 @@ Rename the container `id` to a `new_name`
864 864
865 865 
     HTTP/1.1 204 No Content
866 866
867 
-Query Parameters:
867 
+**Query parameters**:
868 868
869 869 
 -   **name** – new name for the container
870 870
871 
-Status Codes:
871 
+**Status codes**:
872 872
873 873 
 -   **204** – no error
874 874 
 -   **404** – no such container
... ... 
@@ -889,7 +893,7 @@ Pause the container `id`
889 889
890 890 
     HTTP/1.1 204 No Content
891 891
892 
-Status Codes:
892 
+**Status codes**:
893 893
894 894 
 -   **204** – no error
895 895 
 -   **404** – no such container
... ... 
@@ -909,7 +913,7 @@ Unpause the container `id`
909 909
910 910 
     HTTP/1.1 204 No Content
911 911
912 
-Status Codes:
912 
+**Status codes**:
913 913
914 914 
 -   **204** – no error
915 915 
 -   **404** – no such container
... ... 
@@ -934,7 +938,7 @@ Attach to the container `id`
934 934
935 935 
     {{ STREAM }}
936 936
937 
-Query Parameters:
937 
+**Query parameters**:
938 938
939 939 
 -   **logs** – 1/True/true or 0/False/false, return logs. Default `false`.
940 940 
 -   **stream** – 1/True/true or 0/False/false, return stream.
... ... 
@@ -946,7 +950,7 @@ Query Parameters:
946 946 
 -   **stderr** – 1/True/true or 0/False/false, if `logs=true`, return
947 947 
         `stderr` log, if `stream=true`, attach to `stderr`. Default `false`.
948 948
949 
-Status Codes:
949 
+**Status codes**:
950 950
951 951 
 -   **101** – no error, hints proxy about hijacking
952 952 
 -   **200** – no error, no upgrade header found
... ... 
@@ -1014,7 +1018,7 @@ Implements websocket protocol handshake according to [RFC 6455](http://tools.iet
1014 1014
1015 1015 
     {{ STREAM }}
1016 1016
1017 
-Query Parameters:
1017 
+**Query parameters**:
1018 1018
1019 1019 
 -   **logs** – 1/True/true or 0/False/false, return logs. Default `false`.
1020 1020 
 -   **stream** – 1/True/true or 0/False/false, return stream.
... ... 
@@ -1026,7 +1030,7 @@ Query Parameters:
1026 1026 
 -   **stderr** – 1/True/true or 0/False/false, if `logs=true`, return
1027 1027 
         `stderr` log, if `stream=true`, attach to `stderr`. Default `false`.
1028 1028
1029 
-Status Codes:
1029 
+**Status codes**:
1030 1030
1031 1031 
 -   **200** – no error
1032 1032 
 -   **400** – bad parameter
... ... 
@@ -1050,7 +1054,7 @@ Block until container `id` stops, then returns the exit code
1050 1050
1051 1051 
     {"StatusCode": 0}
1052 1052
1053 
-Status Codes:
1053 
+**Status codes**:
1054 1054
1055 1055 
 -   **200** – no error
1056 1056 
 -   **404** – no such container
... ... 
@@ -1070,14 +1074,14 @@ Remove the container `id` from the filesystem
1070 1070
1071 1071 
     HTTP/1.1 204 No Content
1072 1072
1073 
-Query Parameters:
1073 
+**Query parameters**:
1074 1074
1075 1075 
 -   **v** – 1/True/true or 0/False/false, Remove the volumes
1076 1076 
         associated to the container. Default `false`.
1077 1077 
 -   **force** - 1/True/true or 0/False/false, Kill then remove the container.
1078 1078 
         Default `false`.
1079 1079
1080 
-Status Codes:
1080 
+**Status codes**:
1081 1081
1082 1082 
 -   **204** – no error
1083 1083 
 -   **400** – bad parameter
... ... 
@@ -1107,7 +1111,7 @@ Copy files or folders of container `id`
1107 1107
1108 1108 
     {{ TAR STREAM }}
1109 1109
1110 
-Status Codes:
1110 
+**Status codes**:
1111 1111
1112 1112 
 -   **200** – no error
1113 1113 
 -   **404** – no such container
... ... 
@@ -1198,7 +1202,7 @@ digest. You can reference this digest using the value:
1198 1198 
 See the `docker run` and `docker build` commands for examples of digest and tag
1199 1199 
 references on the command line.
1200 1200
1201 
-Query Parameters:
1201 
+**Query parameters**:
1202 1202
1203 1203 
 -   **all** – 1/True/true or 0/False/false, default false
1204 1204 
 -   **filters** – a JSON encoded value of the filters (a map[string][]string) to process on the images list. Available filters:
... ... 
@@ -1242,10 +1246,10 @@ command*](../../reference/builder.md#add)).
1242 1242 
 The build is canceled if the client drops the connection by quitting
1243 1243 
 or being killed.
1244 1244
1245 
-Query Parameters:
1245 
+**Query parameters**:
1246 1246
1247 
--   **dockerfile** - Path within the build context to the `Dockerfile`. This is
1248 
-        ignored if `remote` is specified and points to an external `Dockerfile`.
1247 
+-   **dockerfile** - Path within the build context to the Dockerfile. This is
1248 
+        ignored if `remote` is specified and points to an individual filename.
1249 1249 
 -   **t** – Repository name (and optionally a tag) to be applied to
1250 1250 
         the resulting image in case of success.
1251 1251 
 -   **remote** – A Git repository URI or HTTP/HTTPS context URI. If the
... ... 
@@ -1272,7 +1276,7 @@ Query Parameters:
1272 1272 
 -   **Content-type** – Set to `"application/tar"`.
1273 1273 
 -   **X-Registry-Config** – base64-encoded ConfigFile object
1274 1274
1275 
-Status Codes:
1275 
+**Status codes**:
1276 1276
1277 1277 
 -   **200** – no error
1278 1278 
 -   **500** – server error
... ... 
@@ -1301,7 +1305,7 @@ When using this endpoint to pull an image from the registry, the
1301 1301 
 `X-Registry-Auth` header can be used to include
1302 1302 
 a base64-encoded AuthConfig object.
1303 1303
1304 
-Query Parameters:
1304 
+**Query parameters**:
1305 1305
1306 1306 
 -   **fromImage** – Name of the image to pull.
1307 1307 
 -   **fromSrc** – Source to import.  The value may be a URL from which the image
... ... 
@@ -1313,7 +1317,7 @@ Query Parameters:
1313 1313
1314 1314 
 -   **X-Registry-Auth** – base64-encoded AuthConfig object
1315 1315
1316 
-Status Codes:
1316 
+**Status codes**:
1317 1317
1318 1318 
 -   **200** – no error
1319 1319 
 -   **500** – server error
... ... 
@@ -1367,7 +1371,7 @@ Return low-level information on the image `name`
1367 1367 
          "Size": 6824592
1368 1368 
     }
1369 1369
1370 
-Status Codes:
1370 
+**Status codes**:
1371 1371
1372 1372 
 -   **200** – no error
1373 1373 
 -   **404** – no such image
... ... 
@@ -1421,7 +1425,7 @@ Return the history of the image `name`
1421 1421 
         }
1422 1422 
     ]
1423 1423
1424 
-Status Codes:
1424 
+**Status codes**:
1425 1425
1426 1426 
 -   **200** – no error
1427 1427 
 -   **404** – no such image
... ... 
@@ -1456,7 +1460,7 @@ then be used in the URL. This duplicates the command line's flow.
1456 1456 
     POST /images/registry.acme.com:5000/test/push HTTP/1.1
1457 1457
1458 1458
1459 
-Query Parameters:
1459 
+**Query parameters**:
1460 1460
1461 1461 
 -   **tag** – The tag to associate with the image on the registry. This is optional.
1462 1462
... ... 
@@ -1465,7 +1469,7 @@ Request Headers:
1465 1465 
 -   **X-Registry-Auth** – Include a base64-encoded AuthConfig.
1466 1466 
         object.
1467 1467
1468 
-Status Codes:
1468 
+**Status codes**:
1469 1469
1470 1470 
 -   **200** – no error
1471 1471 
 -   **404** – no such image
... ... 
@@ -1485,13 +1489,13 @@ Tag the image `name` into a repository
1485 1485
1486 1486 
     HTTP/1.1 201 Created
1487 1487
1488 
-Query Parameters:
1488 
+**Query parameters**:
1489 1489
1490 1490 
 -   **repo** – The repository to tag in
1491 1491 
 -   **force** – 1/True/true or 0/False/false, default false
1492 1492 
 -   **tag** - The new tag name
1493 1493
1494 
-Status Codes:
1494 
+**Status codes**:
1495 1495
1496 1496 
 -   **201** – no error
1497 1497 
 -   **400** – bad parameter
... ... 
@@ -1520,12 +1524,12 @@ Remove the image `name` from the filesystem
1520 1520 
      {"Deleted": "53b4f83ac9"}
1521 1521 
     ]
1522 1522
1523 
-Query Parameters:
1523 
+**Query parameters**:
1524 1524
1525 1525 
 -   **force** – 1/True/true or 0/False/false, default false
1526 1526 
 -   **noprune** – 1/True/true or 0/False/false, default false
1527 1527
1528 
-Status Codes:
1528 
+**Status codes**:
1529 1529
1530 1530 
 -   **200** – no error
1531 1531 
 -   **404** – no such image
... ... 
@@ -1554,39 +1558,39 @@ be deprecated and replaced by the `is_automated` property.
1554 1554 
     HTTP/1.1 200 OK
1555 1555 
     Content-Type: application/json
1556 1556
1557 
-        [
1558 
-                {
1559 
-                    "star_count": 12,
1560 
-                    "is_official": false,
1561 
-                    "name": "wma55/u1210sshd",
1562 
-                    "is_trusted": false,
1563 
-                    "is_automated": false,
1564 
-                    "description": "",
1565 
-                },
1566 
-                {
1567 
-                    "star_count": 10,
1568 
-                    "is_official": false,
1569 
-                    "name": "jdswinbank/sshd",
1570 
-                    "is_trusted": false,
1571 
-                    "is_automated": false,
1572 
-                    "description": "",
1573 
-                },
1574 
-                {
1575 
-                    "star_count": 18,
1576 
-                    "is_official": false,
1577 
-                    "name": "vgauthier/sshd",
1578 
-                    "is_trusted": false,
1579 
-                    "is_automated": false,
1580 
-                    "description": "",
1581 
-                }
1582 
-        ...
1583 
-        ]
1557 
+    [
1558 
+            {
1559 
+                "star_count": 12,
1560 
+                "is_official": false,
1561 
+                "name": "wma55/u1210sshd",
1562 
+                "is_trusted": false,
1563 
+                "is_automated": false,
1564 
+                "description": "",
1565 
+            },
1566 
+            {
1567 
+                "star_count": 10,
1568 
+                "is_official": false,
1569 
+                "name": "jdswinbank/sshd",
1570 
+                "is_trusted": false,
1571 
+                "is_automated": false,
1572 
+                "description": "",
1573 
+            },
1574 
+            {
1575 
+                "star_count": 18,
1576 
+                "is_official": false,
1577 
+                "name": "vgauthier/sshd",
1578 
+                "is_trusted": false,
1579 
+                "is_automated": false,
1580 
+                "description": "",
1581 
+            }
1582 
+    ...
1583 
+    ]
1584 1584
1585 
-Query Parameters:
1585 
+**Query parameters**:
1586 1586
1587 1587 
 -   **term** – term to search
1588 1588
1589 
-Status Codes:
1589 
+**Status codes**:
1590 1590
1591 1591 
 -   **200** – no error
1592 1592 
 -   **500** – server error
... ... 
@@ -1615,7 +1619,7 @@ Get the default username and email
1615 1615
1616 1616 
     HTTP/1.1 200 OK
1617 1617
1618 
-Status Codes:
1618 
+**Status codes**:
1619 1619
1620 1620 
 -   **200** – no error
1621 1621 
 -   **204** – no error
... ... 
@@ -1685,7 +1689,7 @@ Display system-wide information
1685 1685 
         "SystemTime": "2015-03-10T11:11:23.730591467-07:00"
1686 1686 
     }
1687 1687
1688 
-Status Codes:
1688 
+**Status codes**:
1689 1689
1690 1690 
 -   **200** – no error
1691 1691 
 -   **500** – server error
... ... 
@@ -1715,7 +1719,7 @@ Show the docker version information
1715 1715 
          "ApiVersion": "1.19"
1716 1716 
     }
1717 1717
1718 
-Status Codes:
1718 
+**Status codes**:
1719 1719
1720 1720 
 -   **200** – no error
1721 1721 
 -   **500** – server error
... ... 
@@ -1737,7 +1741,7 @@ Ping the docker server
1737 1737
1738 1738 
     OK
1739 1739
1740 
-Status Codes:
1740 
+**Status codes**:
1741 1741
1742 1742 
 -   **200** - no error
1743 1743 
 -   **500** - server error
... ... 
@@ -1789,11 +1793,11 @@ Create a new image from a container's changes
1789 1789
1790 1790 
     {"Id": "596069db4bf5"}
1791 1791
1792 
-Json Parameters:
1792 
+**JSON parameters**:
1793 1793
1794 1794 
 -  **config** - the container's configuration
1795 1795
1796 
-Query Parameters:
1796 
+**Query parameters**:
1797 1797
1798 1798 
 -   **container** – source container
1799 1799 
 -   **repo** – repository
... ... 
@@ -1802,7 +1806,7 @@ Query Parameters:
1802 1802 
 -   **author** – author (e.g., "John Hannibal Smith
1803 1803 
     <[hannibal@a-team.com](mailto:hannibal%40a-team.com)>")
1804 1804
1805 
-Status Codes:
1805 
+**Status codes**:
1806 1806
1807 1807 
 -   **201** – no error
1808 1808 
 -   **404** – no such container
... ... 
@@ -1837,16 +1841,16 @@ and Docker images report:
1837 1837 
     {"status": "stop", "id": "dfdf82bd3881","from": "ubuntu:latest", "time":1374067966}
1838 1838 
     {"status": "destroy", "id": "dfdf82bd3881","from": "ubuntu:latest", "time":1374067970}
1839 1839
1840 
-Query Parameters:
1840 
+**Query parameters**:
1841 1841
1842 1842 
 -   **since** – Timestamp used for polling
1843 1843 
 -   **until** – Timestamp used for polling
1844 1844 
 -   **filters** – A json encoded value of the filters (a map[string][]string) to process on the event list. Available filters:
1845 
+  -   `container=<string>`; -- container to filter
1845 1846 
   -   `event=<string>`; -- event to filter
1846 1847 
   -   `image=<string>`; -- image to filter
1847 
-  -   `container=<string>`; -- container to filter
1848 1848
1849 
-Status Codes:
1849 
+**Status codes**:
1850 1850
1851 1851 
 -   **200** – no error
1852 1852 
 -   **500** – server error
... ... 
@@ -1876,7 +1880,7 @@ See the [image tarball format](#image-tarball-format) for more details.
1876 1876
1877 1877 
     Binary data stream
1878 1878
1879 
-Status Codes:
1879 
+**Status codes**:
1880 1880
1881 1881 
 -   **200** – no error
1882 1882 
 -   **500** – server error
... ... 
@@ -1905,7 +1909,7 @@ See the [image tarball format](#image-tarball-format) for more details.
1905 1905
1906 1906 
     Binary data stream
1907 1907
1908 
-Status Codes:
1908 
+**Status codes**:
1909 1909
1910 1910 
 -   **200** – no error
1911 1911 
 -   **500** – server error
... ... 
@@ -1927,7 +1931,7 @@ See the [image tarball format](#image-tarball-format) for more details.
1927 1927
1928 1928 
     HTTP/1.1 200 OK
1929 1929
1930 
-Status Codes:
1930 
+**Status codes**:
1931 1931
1932 1932 
 -   **200** – no error
1933 1933 
 -   **500** – server error
... ... 
@@ -1971,7 +1975,7 @@ Sets up an exec instance in a running container `id`
1971 1971 
        "Tty": false,
1972 1972 
        "Cmd": [
1973 1973 
                      "date"
1974 
-             ],
1974 
+             ]
1975 1975 
       }
1976 1976
1977 1977 
 **Example response**:
... ... 
@@ -1984,7 +1988,7 @@ Sets up an exec instance in a running container `id`
1984 1984 
          "Warnings":[]
1985 1985 
     }
1986 1986
1987 
-Json Parameters:
1987 
+**JSON parameters**:
1988 1988
1989 1989 
 -   **AttachStdin** - Boolean value, attaches to `stdin` of the `exec` command.
1990 1990 
 -   **AttachStdout** - Boolean value, attaches to `stdout` of the `exec` command.
... ... 
@@ -1993,7 +1997,7 @@ Json Parameters:
1993 1993 
 -   **Cmd** - Command to run specified as a string or an array of strings.
1994 1994
1995 1995
1996 
-Status Codes:
1996 
+**Status codes**:
1997 1997
1998 1998 
 -   **201** – no error
1999 1999 
 -   **404** – no such container
... ... 
@@ -2013,7 +2017,7 @@ interactive session with the `exec` command.
2013 2013
2014 2014 
     {
2015 2015 
      "Detach": false,
2016 
-     "Tty": false,
2016 
+     "Tty": false
2017 2017 
     }
2018 2018
2019 2019 
 **Example response**:
... ... 
@@ -2023,12 +2027,12 @@ interactive session with the `exec` command.
2023 2023
2024 2024 
     {{ STREAM }}
2025 2025
2026 
-Json Parameters:
2026 
+**JSON parameters**:
2027 2027
2028 2028 
 -   **Detach** - Detach from the `exec` command.
2029 2029 
 -   **Tty** - Boolean value to allocate a pseudo-TTY.
2030 2030
2031 
-Status Codes:
2031 
+**Status codes**:
2032 2032
2033 2033 
 -   **200** – no error
2034 2034 
 -   **404** – no such exec instance
... ... 
@@ -2040,12 +2044,12 @@ Status Codes:
2040 2040
2041 2041 
 `POST /exec/(id)/resize`
2042 2042
2043 
-Resizes the `tty` session used by the `exec` command `id`.
2043 
+Resizes the `tty` session used by the `exec` command `id`.  The unit is number of characters.
2044 2044 
 This API is valid only if `tty` was specified as part of creating and starting the `exec` command.
2045 2045
2046 2046 
 **Example request**:
2047 2047
2048 
-    POST /exec/e90e34656806/resize HTTP/1.1
2048 
+    POST /exec/e90e34656806/resize?h=40&w=80 HTTP/1.1
2049 2049 
     Content-Type: text/plain
2050 2050
2051 2051 
 **Example response**:
... ... 
@@ -2053,12 +2057,12 @@ This API is valid only if `tty` was specified as part of creating and starting t
2053 2053 
     HTTP/1.1 201 Created
2054 2054 
     Content-Type: text/plain
2055 2055
2056 
-Query Parameters:
2056 
+**Query parameters**:
2057 2057
2058 2058 
 -   **h** – height of `tty` session
2059 2059 
 -   **w** – width
2060 2060
2061 
-Status Codes:
2061 
+**Status codes**:
2062 2062
2063 2063 
 -   **201** – no error
2064 2064 
 -   **404** – no such exec instance
... ... 
@@ -2162,7 +2166,7 @@ Return low-level information about the `exec` command `id`.
2162 2162 
       }
2163 2163 
     }
2164 2164
2165 
-Status Codes:
2165 
+**Status codes**:
2166 2166
2167 2167 
 -   **200** – no error
2168 2168 
 -   **404** – no such exec instance
docs/reference/api/docker_remote_api_v1.20.md
History View file @ 0194094
... ... 
@@ -96,7 +96,7 @@ List containers
96 96 
          }
97 97 
     ]
98 98
99 
-Query Parameters:
99 
+**Query parameters**:
100 100
101 101 
 -   **all** – 1/True/true or 0/False/false, Show all containers.
102 102 
         Only running containers are shown by default (i.e., this defaults to false)
... ... 
@@ -113,7 +113,7 @@ Query Parameters:
113 113 
   -   `status=`(`created`|`restarting`|`running`|`paused`|`exited`)
114 114 
   -   `label=key` or `label="key=value"` of a container label
115 115
116 
-Status Codes:
116 
+**Status codes**:
117 117
118 118 
 -   **200** – no error
119 119 
 -   **400** – bad parameter
... ... 
@@ -209,7 +209,7 @@ Create a container
209 209 
            "Warnings":[]
210 210 
       }
211 211
212 
-Json Parameters:
212 
+**JSON parameters**:
213 213
214 214 
 -   **Hostname** - A string value containing the hostname to use for the
215 215 
       container.
... ... 
@@ -303,12 +303,12 @@ Json Parameters:
303 303 
           `json-file` logging driver.
304 304 
     -   **CgroupParent** - Path to `cgroups` under which the container's `cgroup` is created. If the path is not absolute, the path is considered to be relative to the `cgroups` path of the init process. Cgroups are created if they do not already exist.
305 305
306 
-Query Parameters:
306 
+**Query parameters**:
307 307
308 308 
 -   **name** – Assign the specified name to the container. Must
309 309 
     match `/?[a-zA-Z0-9_-]+`.
310 310
311 
-Status Codes:
311 
+**Status codes**:
312 312
313 313 
 -   **201** – no error
314 314 
 -   **400** – bad parameter
... ... 
@@ -323,7 +323,6 @@ Status Codes:
323 323
324 324 
 Return low-level information on the container `id`
325 325
326 
-
327 326 
 **Example request**:
328 327
329 328 
       GET /containers/4fa6e0f0c678/json HTTP/1.1
... ... 
@@ -454,7 +453,7 @@ Return low-level information on the container `id`
454 454 
 		]
455 455 
 	}
456 456
457 
-Status Codes:
457 
+**Status codes**:
458 458
459 459 
 -   **200** – no error
460 460 
 -   **404** – no such container
... ... 
@@ -514,11 +513,11 @@ supported on Windows.
514 514 
       ],
515 515 
     }
516 516
517 
-Query Parameters:
517 
+**Query parameters**:
518 518
519 519 
 -   **ps_args** – `ps` arguments to use (e.g., `aux`), defaults to `-ef`
520 520
521 
-Status Codes:
521 
+**Status codes**:
522 522
523 523 
 -   **200** – no error
524 524 
 -   **404** – no such container
... ... 
@@ -546,7 +545,7 @@ Get `stdout` and `stderr` logs from the container ``id``
546 546
547 547 
      {{ STREAM }}
548 548
549 
-Query Parameters:
549 
+**Query parameters**:
550 550
551 551 
 -   **follow** – 1/True/true or 0/False/false, return stream. Default `false`.
552 552 
 -   **stdout** – 1/True/true or 0/False/false, show `stdout` log. Default `false`.
... ... 
@@ -557,7 +556,7 @@ Query Parameters:
557 557 
         every log line. Default `false`.
558 558 
 -   **tail** – Output specified number of lines at the end of logs: `all` or `<number>`. Default all.
559 559
560 
-Status Codes:
560 
+**Status codes**:
561 561
562 562 
 -   **101** – no error, hints proxy about hijacking
563 563 
 -   **200** – no error, no upgrade header found
... ... 
@@ -600,7 +599,7 @@ Values for `Kind`:
600 600 
 - `1`: Add
601 601 
 - `2`: Delete
602 602
603 
-Status Codes:
603 
+**Status codes**:
604 604
605 605 
 -   **200** – no error
606 606 
 -   **404** – no such container
... ... 
@@ -623,7 +622,7 @@ Export the contents of container `id`
623 623
624 624 
     {{ TAR STREAM }}
625 625
626 
-Status Codes:
626 
+**Status codes**:
627 627
628 628 
 -   **200** – no error
629 629 
 -   **404** – no such container
... ... 
@@ -728,11 +727,11 @@ This endpoint returns a live stream of a container's resource usage statistics.
728 728
729 729 
 The precpu_stats is the cpu statistic of last read, which is used for calculating the cpu usage percent. It is not the exact copy of the “cpu_stats” field.
730 730
731 
-Query Parameters:
731 
+**Query parameters**:
732 732
733 733 
 -   **stream** – 1/True/true or 0/False/false, pull stats once then disconnect. Default `true`.
734 734
735 
-Status Codes:
735 
+**Status codes**:
736 736
737 737 
 -   **200** – no error
738 738 
 -   **404** – no such container
... ... 
@@ -754,7 +753,12 @@ Resize the TTY for container with  `id`. You must restart the container for the
754 754 
       Content-Length: 0
755 755 
       Content-Type: text/plain; charset=utf-8
756 756
757 
-Status Codes:
757 
+**Query parameters**:
758 
+
759 
+-   **h** – height of `tty` session
760 
+-   **w** – width
761 
+
762 
+**Status codes**:
758 763
759 764 
 -   **200** – no error
760 765 
 -   **404** – No such container
... ... 
@@ -778,7 +782,7 @@ Start the container `id`
778 778
779 779 
     HTTP/1.1 204 No Content
780 780
781 
-Status Codes:
781 
+**Status codes**:
782 782
783 783 
 -   **204** – no error
784 784 
 -   **304** – container already started
... ... 
@@ -799,11 +803,11 @@ Stop the container `id`
799 799
800 800 
     HTTP/1.1 204 No Content
801 801
802 
-Query Parameters:
802 
+**Query parameters**:
803 803
804 804 
 -   **t** – number of seconds to wait before killing the container
805 805
806 
-Status Codes:
806 
+**Status codes**:
807 807
808 808 
 -   **204** – no error
809 809 
 -   **304** – container already stopped
... ... 
@@ -824,11 +828,11 @@ Restart the container `id`
824 824
825 825 
     HTTP/1.1 204 No Content
826 826
827 
-Query Parameters:
827 
+**Query parameters**:
828 828
829 829 
 -   **t** – number of seconds to wait before killing the container
830 830
831 
-Status Codes:
831 
+**Status codes**:
832 832
833 833 
 -   **204** – no error
834 834 
 -   **404** – no such container
... ... 
@@ -848,12 +852,12 @@ Kill the container `id`
848 848
849 849 
     HTTP/1.1 204 No Content
850 850
851 
-Query Parameters
851 
+**Query parameters**:
852 852
853 853 
 -   **signal** - Signal to send to the container: integer or string like `SIGINT`.
854 854 
         When not set, `SIGKILL` is assumed and the call waits for the container to exit.
855 855
856 
-Status Codes:
856 
+**Status codes**:
857 857
858 858 
 -   **204** – no error
859 859 
 -   **404** – no such container
... ... 
@@ -873,11 +877,11 @@ Rename the container `id` to a `new_name`
873 873
874 874 
     HTTP/1.1 204 No Content
875 875
876 
-Query Parameters:
876 
+**Query parameters**:
877 877
878 878 
 -   **name** – new name for the container
879 879
880 
-Status Codes:
880 
+**Status codes**:
881 881
882 882 
 -   **204** – no error
883 883 
 -   **404** – no such container
... ... 
@@ -898,7 +902,7 @@ Pause the container `id`
898 898
899 899 
     HTTP/1.1 204 No Content
900 900
901 
-Status Codes:
901 
+**Status codes**:
902 902
903 903 
 -   **204** – no error
904 904 
 -   **404** – no such container
... ... 
@@ -918,7 +922,7 @@ Unpause the container `id`
918 918
919 919 
     HTTP/1.1 204 No Content
920 920
921 
-Status Codes:
921 
+**Status codes**:
922 922
923 923 
 -   **204** – no error
924 924 
 -   **404** – no such container
... ... 
@@ -943,7 +947,7 @@ Attach to the container `id`
943 943
944 944 
     {{ STREAM }}
945 945
946 
-Query Parameters:
946 
+**Query parameters**:
947 947
948 948 
 -   **logs** – 1/True/true or 0/False/false, return logs. Default `false`.
949 949 
 -   **stream** – 1/True/true or 0/False/false, return stream.
... ... 
@@ -955,7 +959,7 @@ Query Parameters:
955 955 
 -   **stderr** – 1/True/true or 0/False/false, if `logs=true`, return
956 956 
         `stderr` log, if `stream=true`, attach to `stderr`. Default `false`.
957 957
958 
-Status Codes:
958 
+**Status codes**:
959 959
960 960 
 -   **101** – no error, hints proxy about hijacking
961 961 
 -   **200** – no error, no upgrade header found
... ... 
@@ -1023,7 +1027,7 @@ Implements websocket protocol handshake according to [RFC 6455](http://tools.iet
1023 1023
1024 1024 
     {{ STREAM }}
1025 1025
1026 
-Query Parameters:
1026 
+**Query parameters**:
1027 1027
1028 1028 
 -   **logs** – 1/True/true or 0/False/false, return logs. Default `false`.
1029 1029 
 -   **stream** – 1/True/true or 0/False/false, return stream.
... ... 
@@ -1035,7 +1039,7 @@ Query Parameters:
1035 1035 
 -   **stderr** – 1/True/true or 0/False/false, if `logs=true`, return
1036 1036 
         `stderr` log, if `stream=true`, attach to `stderr`. Default `false`.
1037 1037
1038 
-Status Codes:
1038 
+**Status codes**:
1039 1039
1040 1040 
 -   **200** – no error
1041 1041 
 -   **400** – bad parameter
... ... 
@@ -1059,7 +1063,7 @@ Block until container `id` stops, then returns the exit code
1059 1059
1060 1060 
     {"StatusCode": 0}
1061 1061
1062 
-Status Codes:
1062 
+**Status codes**:
1063 1063
1064 1064 
 -   **200** – no error
1065 1065 
 -   **404** – no such container
... ... 
@@ -1079,14 +1083,14 @@ Remove the container `id` from the filesystem
1079 1079
1080 1080 
     HTTP/1.1 204 No Content
1081 1081
1082 
-Query Parameters:
1082 
+**Query parameters**:
1083 1083
1084 1084 
 -   **v** – 1/True/true or 0/False/false, Remove the volumes
1085 1085 
         associated to the container. Default `false`.
1086 1086 
 -   **force** - 1/True/true or 0/False/false, Kill then remove the container.
1087 1087 
         Default `false`.
1088 1088
1089 
-Status Codes:
1089 
+**Status codes**:
1090 1090
1091 1091 
 -   **204** – no error
1092 1092 
 -   **400** – bad parameter
... ... 
@@ -1118,7 +1122,7 @@ Copy files or folders of container `id`
1118 1118
1119 1119 
     {{ TAR STREAM }}
1120 1120
1121 
-Status Codes:
1121 
+**Status codes**:
1122 1122
1123 1123 
 -   **200** – no error
1124 1124 
 -   **404** – no such container
... ... 
@@ -1137,7 +1141,7 @@ following section.
1137 1137
1138 1138 
 Get a tar archive of a resource in the filesystem of container `id`.
1139 1139
1140 
-Query Parameters:
1140 
+**Query parameters**:
1141 1141
1142 1142 
 - **path** - resource in the container's filesystem to archive. Required.
1143 1143
... ... 
@@ -1148,39 +1152,41 @@ Query Parameters:
1148 1148 
     indicates that only the contents of the **path** directory should be
1149 1149 
     copied. A symlink is always resolved to its target.
1150 1150
1151 
-    **Note**: It is not possible to copy certain system files such as resources
1152 
-    under `/proc`, `/sys`, `/dev`, and mounts created by the user in the
1153 
-    container.
1151 
+    > **Note**: It is not possible to copy certain system files such as resources
1152 
+    > under `/proc`, `/sys`, `/dev`, and mounts created by the user in the
1153 
+    > container.
1154 1154
1155 1155 
 **Example request**:
1156 1156
1157 
-        GET /containers/8cce319429b2/archive?path=/root HTTP/1.1
1157 
+    GET /containers/8cce319429b2/archive?path=/root HTTP/1.1
1158 1158
1159 1159 
 **Example response**:
1160 1160
1161 
-        HTTP/1.1 200 OK
1162 
-        Content-Type: application/x-tar
1163 
-        X-Docker-Container-Path-Stat: eyJuYW1lIjoicm9vdCIsInNpemUiOjQwOTYsIm1vZGUiOjIxNDc0ODQwOTYsIm10aW1lIjoiMjAxNC0wMi0yN1QyMDo1MToyM1oiLCJsaW5rVGFyZ2V0IjoiIn0=
1161 
+    HTTP/1.1 200 OK
1162 
+    Content-Type: application/x-tar
1163 
+    X-Docker-Container-Path-Stat: eyJuYW1lIjoicm9vdCIsInNpemUiOjQwOTYsIm1vZGUiOjIxNDc0ODQwOTYsIm10aW1lIjoiMjAxNC0wMi0yN1QyMDo1MToyM1oiLCJsaW5rVGFyZ2V0IjoiIn0=
1164 1164
1165 
-        {{ TAR STREAM }}
1165 
+    {{ TAR STREAM }}
1166 1166
1167 1167 
 On success, a response header `X-Docker-Container-Path-Stat` will be set to a
1168 1168 
 base64-encoded JSON object containing some filesystem header information about
1169 1169 
 the archived resource. The above example value would decode to the following
1170 1170 
 JSON object (whitespace added for readability):
1171 1171
1172 
-        {
1173 
-            "name": "root",
1174 
-            "size": 4096,
1175 
-            "mode": 2147484096,
1176 
-            "mtime": "2014-02-27T20:51:23Z",
1177 
-            "linkTarget": ""
1178 
-        }
1172 
+```json
1173 
+{
1174 
+    "name": "root",
1175 
+    "size": 4096,
1176 
+    "mode": 2147484096,
1177 
+    "mtime": "2014-02-27T20:51:23Z",
1178 
+    "linkTarget": ""
1179 
+}
1180 
+```
1179 1181
1180 1182 
 A `HEAD` request can also be made to this endpoint if only this information is
1181 1183 
 desired.
1182 1184
1183 
-Status Codes:
1185 
+**Status codes**:
1184 1186
1185 1187 
 - **200** - success, returns archive of copied resource
1186 1188 
 - **400** - client error, bad parameter, details in JSON response body, one of:
... ... 
@@ -1199,7 +1205,7 @@ Status Codes:
1199 1199 
 Upload a tar archive to be extracted to a path in the filesystem of container
1200 1200 
 `id`.
1201 1201
1202 
-Query Parameters:
1202 
+**Query parameters**:
1203 1203
1204 1204 
 - **path** - path to a directory in the container
1205 1205 
     to extract the archive's contents into. Required.
... ... 
@@ -1212,16 +1218,16 @@ Query Parameters:
1212 1212
1213 1213 
 **Example request**:
1214 1214
1215 
-        PUT /containers/8cce319429b2/archive?path=/vol1 HTTP/1.1
1216 
-        Content-Type: application/x-tar
1215 
+    PUT /containers/8cce319429b2/archive?path=/vol1 HTTP/1.1
1216 
+    Content-Type: application/x-tar
1217 1217
1218 
-        {{ TAR STREAM }}
1218 
+    {{ TAR STREAM }}
1219 1219
1220 1220 
 **Example response**:
1221 1221
1222 
-        HTTP/1.1 200 OK
1222 
+    HTTP/1.1 200 OK
1223 1223
1224 
-Status Codes:
1224 
+**Status codes**:
1225 1225
1226 1226 
 - **200** – the content was extracted successfully
1227 1227 
 - **400** - client error, bad parameter, details in JSON response body, one of:
... ... 
@@ -1323,7 +1329,7 @@ digest. You can reference this digest using the value:
1323 1323 
 See the `docker run` and `docker build` commands for examples of digest and tag
1324 1324 
 references on the command line.
1325 1325
1326 
-Query Parameters:
1326 
+**Query parameters**:
1327 1327
1328 1328 
 -   **all** – 1/True/true or 0/False/false, default false
1329 1329 
 -   **filters** – a JSON encoded value of the filters (a map[string][]string) to process on the images list. Available filters:
... ... 
@@ -1367,7 +1373,7 @@ command*](../../reference/builder.md#add)).
1367 1367 
 The build is canceled if the client drops the connection by quitting
1368 1368 
 or being killed.
1369 1369
1370 
-Query Parameters:
1370 
+**Query parameters**:
1371 1371
1372 1372 
 -   **dockerfile** - Path within the build context to the Dockerfile. This is
1373 1373 
         ignored if `remote` is specified and points to an individual filename.
... ... 
@@ -1375,7 +1381,7 @@ Query Parameters:
1375 1375 
         the resulting image in case of success.
1376 1376 
 -   **remote** – A Git repository URI or HTTP/HTTPS URI build source. If the
1377 1377 
         URI specifies a filename, the file's contents are placed into a file
1378 
-		called `Dockerfile`.
1378 
+        called `Dockerfile`.
1379 1379 
 -   **q** – Suppress verbose build output.
1380 1380 
 -   **nocache** – Do not use the cache when building the image.
1381 1381 
 -   **pull** - Attempt to pull the image even if an older image exists locally.
... ... 
@@ -1414,7 +1420,7 @@ Query Parameters:
1414 1414 
     be specified with both a "https://" prefix and a "/v1/" suffix even
1415 1415 
     though Docker will prefer to use the v2 registry API.
1416 1416
1417 
-Status Codes:
1417 
+**Status codes**:
1418 1418
1419 1419 
 -   **200** – no error
1420 1420 
 -   **500** – server error
... ... 
@@ -1443,7 +1449,7 @@ When using this endpoint to pull an image from the registry, the
1443 1443 
 `X-Registry-Auth` header can be used to include
1444 1444 
 a base64-encoded AuthConfig object.
1445 1445
1446 
-Query Parameters:
1446 
+**Query parameters**:
1447 1447
1448 1448 
 -   **fromImage** – Name of the image to pull.
1449 1449 
 -   **fromSrc** – Source to import.  The value may be a URL from which the image
... ... 
@@ -1455,7 +1461,7 @@ Query Parameters:
1455 1455
1456 1456 
 -   **X-Registry-Auth** – base64-encoded AuthConfig object
1457 1457
1458 
-Status Codes:
1458 
+**Status codes**:
1459 1459
1460 1460 
 -   **200** – no error
1461 1461 
 -   **500** – server error
... ... 
@@ -1508,7 +1514,7 @@ Return low-level information on the image `name`
1508 1508 
          "Size": 6824592
1509 1509 
     }
1510 1510
1511 
-Status Codes:
1511 
+**Status codes**:
1512 1512
1513 1513 
 -   **200** – no error
1514 1514 
 -   **404** – no such image
... ... 
@@ -1562,7 +1568,7 @@ Return the history of the image `name`
1562 1562 
         }
1563 1563 
     ]
1564 1564
1565 
-Status Codes:
1565 
+**Status codes**:
1566 1566
1567 1567 
 -   **200** – no error
1568 1568 
 -   **404** – no such image
... ... 
@@ -1597,7 +1603,7 @@ then be used in the URL. This duplicates the command line's flow.
1597 1597 
     POST /images/registry.acme.com:5000/test/push HTTP/1.1
1598 1598
1599 1599
1600 
-Query Parameters:
1600 
+**Query parameters**:
1601 1601
1602 1602 
 -   **tag** – The tag to associate with the image on the registry. This is optional.
1603 1603
... ... 
@@ -1606,7 +1612,7 @@ Request Headers:
1606 1606 
 -   **X-Registry-Auth** – Include a base64-encoded AuthConfig.
1607 1607 
         object.
1608 1608
1609 
-Status Codes:
1609 
+**Status codes**:
1610 1610
1611 1611 
 -   **200** – no error
1612 1612 
 -   **404** – no such image
... ... 
@@ -1626,13 +1632,13 @@ Tag the image `name` into a repository
1626 1626
1627 1627 
     HTTP/1.1 201 Created
1628 1628
1629 
-Query Parameters:
1629 
+**Query parameters**:
1630 1630
1631 1631 
 -   **repo** – The repository to tag in
1632 1632 
 -   **force** – 1/True/true or 0/False/false, default false
1633 1633 
 -   **tag** - The new tag name
1634 1634
1635 
-Status Codes:
1635 
+**Status codes**:
1636 1636
1637 1637 
 -   **201** – no error
1638 1638 
 -   **400** – bad parameter
... ... 
@@ -1661,12 +1667,12 @@ Remove the image `name` from the filesystem
1661 1661 
      {"Deleted": "53b4f83ac9"}
1662 1662 
     ]
1663 1663
1664 
-Query Parameters:
1664 
+**Query parameters**:
1665 1665
1666 1666 
 -   **force** – 1/True/true or 0/False/false, default false
1667 1667 
 -   **noprune** – 1/True/true or 0/False/false, default false
1668 1668
1669 
-Status Codes:
1669 
+**Status codes**:
1670 1670
1671 1671 
 -   **200** – no error
1672 1672 
 -   **404** – no such image
... ... 
@@ -1717,11 +1723,11 @@ Search for an image on [Docker Hub](https://hub.docker.com).
1717 1717 
     ...
1718 1718 
     ]
1719 1719
1720 
-Query Parameters:
1720 
+**Query parameters**:
1721 1721
1722 1722 
 -   **term** – term to search
1723 1723
1724 
-Status Codes:
1724 
+**Status codes**:
1725 1725
1726 1726 
 -   **200** – no error
1727 1727 
 -   **500** – server error
... ... 
@@ -1750,7 +1756,7 @@ Get the default username and email
1750 1750
1751 1751 
     HTTP/1.1 200 OK
1752 1752
1753 
-Status Codes:
1753 
+**Status codes**:
1754 1754
1755 1755 
 -   **200** – no error
1756 1756 
 -   **204** – no error
... ... 
@@ -1820,7 +1826,7 @@ Display system-wide information
1820 1820 
         "SystemTime": "2015-03-10T11:11:23.730591467-07:00"
1821 1821 
     }
1822 1822
1823 
-Status Codes:
1823 
+**Status codes**:
1824 1824
1825 1825 
 -   **200** – no error
1826 1826 
 -   **500** – server error
... ... 
@@ -1851,7 +1857,7 @@ Show the docker version information
1851 1851 
          "Experimental": false
1852 1852 
     }
1853 1853
1854 
-Status Codes:
1854 
+**Status codes**:
1855 1855
1856 1856 
 -   **200** – no error
1857 1857 
 -   **500** – server error
... ... 
@@ -1873,7 +1879,7 @@ Ping the docker server
1873 1873
1874 1874 
     OK
1875 1875
1876 
-Status Codes:
1876 
+**Status codes**:
1877 1877
1878 1878 
 -   **200** - no error
1879 1879 
 -   **500** - server error
... ... 
@@ -1929,11 +1935,11 @@ Create a new image from a container's changes
1929 1929
1930 1930 
     {"Id": "596069db4bf5"}
1931 1931
1932 
-Json Parameters:
1932 
+**JSON parameters**:
1933 1933
1934 1934 
 -  **config** - the container's configuration
1935 1935
1936 
-Query Parameters:
1936 
+**Query parameters**:
1937 1937
1938 1938 
 -   **container** – source container
1939 1939 
 -   **repo** – repository
... ... 
@@ -1944,7 +1950,7 @@ Query Parameters:
1944 1944 
 -   **pause** – 1/True/true or 0/False/false, whether to pause the container before committing
1945 1945 
 -   **changes** – Dockerfile instructions to apply while committing
1946 1946
1947 
-Status Codes:
1947 
+**Status codes**:
1948 1948
1949 1949 
 -   **201** – no error
1950 1950 
 -   **404** – no such container
... ... 
@@ -1979,16 +1985,16 @@ and Docker images report:
1979 1979 
     {"status": "stop", "id": "dfdf82bd3881","from": "ubuntu:latest", "time":1374067966}
1980 1980 
     {"status": "destroy", "id": "dfdf82bd3881","from": "ubuntu:latest", "time":1374067970}
1981 1981
1982 
-Query Parameters:
1982 
+**Query parameters**:
1983 1983
1984 1984 
 -   **since** – Timestamp used for polling
1985 1985 
 -   **until** – Timestamp used for polling
1986 1986 
 -   **filters** – A json encoded value of the filters (a map[string][]string) to process on the event list. Available filters:
1987 
+  -   `container=<string>`; -- container to filter
1987 1988 
   -   `event=<string>`; -- event to filter
1988 1989 
   -   `image=<string>`; -- image to filter
1989 
-  -   `container=<string>`; -- container to filter
1990 1990
1991 
-Status Codes:
1991 
+**Status codes**:
1992 1992
1993 1993 
 -   **200** – no error
1994 1994 
 -   **500** – server error
... ... 
@@ -2018,7 +2024,7 @@ See the [image tarball format](#image-tarball-format) for more details.
2018 2018
2019 2019 
     Binary data stream
2020 2020
2021 
-Status Codes:
2021 
+**Status codes**:
2022 2022
2023 2023 
 -   **200** – no error
2024 2024 
 -   **500** – server error
... ... 
@@ -2047,7 +2053,7 @@ See the [image tarball format](#image-tarball-format) for more details.
2047 2047
2048 2048 
     Binary data stream
2049 2049
2050 
-Status Codes:
2050 
+**Status codes**:
2051 2051
2052 2052 
 -   **200** – no error
2053 2053 
 -   **500** – server error
... ... 
@@ -2069,7 +2075,7 @@ See the [image tarball format](#image-tarball-format) for more details.
2069 2069
2070 2070 
     HTTP/1.1 200 OK
2071 2071
2072 
-Status Codes:
2072 
+**Status codes**:
2073 2073
2074 2074 
 -   **200** – no error
2075 2075 
 -   **500** – server error
... ... 
@@ -2126,7 +2132,7 @@ Sets up an exec instance in a running container `id`
2126 2126 
          "Warnings":[]
2127 2127 
     }
2128 2128
2129 
-Json Parameters:
2129 
+**JSON parameters**:
2130 2130
2131 2131 
 -   **AttachStdin** - Boolean value, attaches to `stdin` of the `exec` command.
2132 2132 
 -   **AttachStdout** - Boolean value, attaches to `stdout` of the `exec` command.
... ... 
@@ -2135,7 +2141,7 @@ Json Parameters:
2135 2135 
 -   **Cmd** - Command to run specified as a string or an array of strings.
2136 2136
2137 2137
2138 
-Status Codes:
2138 
+**Status codes**:
2139 2139
2140 2140 
 -   **201** – no error
2141 2141 
 -   **404** – no such container
... ... 
@@ -2165,12 +2171,12 @@ interactive session with the `exec` command.
2165 2165
2166 2166 
     {{ STREAM }}
2167 2167
2168 
-Json Parameters:
2168 
+**JSON parameters**:
2169 2169
2170 2170 
 -   **Detach** - Detach from the `exec` command.
2171 2171 
 -   **Tty** - Boolean value to allocate a pseudo-TTY.
2172 2172
2173 
-Status Codes:
2173 
+**Status codes**:
2174 2174
2175 2175 
 -   **200** – no error
2176 2176 
 -   **404** – no such exec instance
... ... 
@@ -2195,12 +2201,12 @@ This API is valid only if `tty` was specified as part of creating and starting t
2195 2195 
     HTTP/1.1 201 Created
2196 2196 
     Content-Type: text/plain
2197 2197
2198 
-Query Parameters:
2198 
+**Query parameters**:
2199 2199
2200 2200 
 -   **h** – height of `tty` session
2201 2201 
 -   **w** – width
2202 2202
2203 
-Status Codes:
2203 
+**Status codes**:
2204 2204
2205 2205 
 -   **201** – no error
2206 2206 
 -   **404** – no such exec instance
... ... 
@@ -2302,7 +2308,7 @@ Return low-level information about the `exec` command `id`.
2302 2302 
       }
2303 2303 
     }
2304 2304
2305 
-Status Codes:
2305 
+**Status codes**:
2306 2306
2307 2307 
 -   **200** – no error
2308 2308 
 -   **404** – no such exec instance
docs/reference/api/docker_remote_api_v1.21.md
History View file @ 0194094
... ... 
@@ -100,7 +100,7 @@ List containers
100 100 
          }
101 101 
     ]
102 102
103 
-Query Parameters:
103 
+**Query parameters**:
104 104
105 105 
 -   **all** – 1/True/true or 0/False/false, Show all containers.
106 106 
         Only running containers are shown by default (i.e., this defaults to false)
... ... 
@@ -117,7 +117,7 @@ Query Parameters:
117 117 
   -   `status=`(`created`|`restarting`|`running`|`paused`|`exited`)
118 118 
   -   `label=key` or `label="key=value"` of a container label
119 119
120 
-Status Codes:
120 
+**Status codes**:
121 121
122 122 
 -   **200** – no error
123 123 
 -   **400** – bad parameter
... ... 
@@ -219,7 +219,7 @@ Create a container
219 219 
            "Warnings":[]
220 220 
       }
221 221
222 
-Json Parameters:
222 
+**JSON parameters**:
223 223
224 224 
 -   **Hostname** - A string value containing the hostname to use for the
225 225 
       container.
... ... 
@@ -322,12 +322,12 @@ Json Parameters:
322 322 
     -   **CgroupParent** - Path to `cgroups` under which the container's `cgroup` is created. If the path is not absolute, the path is considered to be relative to the `cgroups` path of the init process. Cgroups are created if they do not already exist.
323 323 
     -   **VolumeDriver** - Driver that this container users to mount volumes.
324 324
325 
-Query Parameters:
325 
+**Query parameters**:
326 326
327 327 
 -   **name** – Assign the specified name to the container. Must
328 328 
     match `/?[a-zA-Z0-9_-]+`.
329 329
330 
-Status Codes:
330 
+**Status codes**:
331 331
332 332 
 -   **201** – no error
333 333 
 -   **400** – bad parameter
... ... 
@@ -342,7 +342,6 @@ Status Codes:
342 342
343 343 
 Return low-level information on the container `id`
344 344
345 
-
346 345 
 **Example request**:
347 346
348 347 
       GET /containers/4fa6e0f0c678/json HTTP/1.1
... ... 
@@ -517,11 +516,11 @@ Return low-level information on the container `id`
517 517 
     ....
518 518 
     }
519 519
520 
-Query Parameters:
520 
+**Query parameters**:
521 521
522 522 
 -   **size** – 1/True/true or 0/False/false, return container size information. Default is `false`.
523 523
524 
-Status Codes:
524 
+**Status codes**:
525 525
526 526 
 -   **200** – no error
527 527 
 -   **404** – no such container
... ... 
@@ -581,11 +580,11 @@ supported on Windows.
581 581 
       ],
582 582 
     }
583 583
584 
-Query Parameters:
584 
+**Query parameters**:
585 585
586 586 
 -   **ps_args** – `ps` arguments to use (e.g., `aux`), defaults to `-ef`
587 587
588 
-Status Codes:
588 
+**Status codes**:
589 589
590 590 
 -   **200** – no error
591 591 
 -   **404** – no such container
... ... 
@@ -613,7 +612,7 @@ Get `stdout` and `stderr` logs from the container ``id``
613 613
614 614 
      {{ STREAM }}
615 615
616 
-Query Parameters:
616 
+**Query parameters**:
617 617
618 618 
 -   **follow** – 1/True/true or 0/False/false, return stream. Default `false`.
619 619 
 -   **stdout** – 1/True/true or 0/False/false, show `stdout` log. Default `false`.
... ... 
@@ -624,7 +623,7 @@ Query Parameters:
624 624 
         every log line. Default `false`.
625 625 
 -   **tail** – Output specified number of lines at the end of logs: `all` or `<number>`. Default all.
626 626
627 
-Status Codes:
627 
+**Status codes**:
628 628
629 629 
 -   **101** – no error, hints proxy about hijacking
630 630 
 -   **200** – no error, no upgrade header found
... ... 
@@ -667,7 +666,7 @@ Values for `Kind`:
667 667 
 - `1`: Add
668 668 
 - `2`: Delete
669 669
670 
-Status Codes:
670 
+**Status codes**:
671 671
672 672 
 -   **200** – no error
673 673 
 -   **404** – no such container
... ... 
@@ -690,7 +689,7 @@ Export the contents of container `id`
690 690
691 691 
     {{ TAR STREAM }}
692 692
693 
-Status Codes:
693 
+**Status codes**:
694 694
695 695 
 -   **200** – no error
696 696 
 -   **404** – no such container
... ... 
@@ -807,11 +806,11 @@ This endpoint returns a live stream of a container's resource usage statistics.
807 807
808 808 
 The precpu_stats is the cpu statistic of last read, which is used for calculating the cpu usage percent. It is not the exact copy of the “cpu_stats” field.
809 809
810 
-Query Parameters:
810 
+**Query parameters**:
811 811
812 812 
 -   **stream** – 1/True/true or 0/False/false, pull stats once then disconnect. Default `true`.
813 813
814 
-Status Codes:
814 
+**Status codes**:
815 815
816 816 
 -   **200** – no error
817 817 
 -   **404** – no such container
... ... 
@@ -833,12 +832,12 @@ Resize the TTY for container with  `id`. The unit is number of characters. You m
833 833 
       Content-Length: 0
834 834 
       Content-Type: text/plain; charset=utf-8
835 835
836 
-Query Parameters:
836 
+**Query parameters**:
837 837
838 838 
 -   **h** – height of `tty` session
839 839 
 -   **w** – width
840 840
841 
-Status Codes:
841 
+**Status codes**:
842 842
843 843 
 -   **200** – no error
844 844 
 -   **404** – No such container
... ... 
@@ -862,7 +861,7 @@ Start the container `id`
862 862
863 863 
     HTTP/1.1 204 No Content
864 864
865 
-Status Codes:
865 
+**Status codes**:
866 866
867 867 
 -   **204** – no error
868 868 
 -   **304** – container already started
... ... 
@@ -883,11 +882,11 @@ Stop the container `id`
883 883
884 884 
     HTTP/1.1 204 No Content
885 885
886 
-Query Parameters:
886 
+**Query parameters**:
887 887
888 888 
 -   **t** – number of seconds to wait before killing the container
889 889
890 
-Status Codes:
890 
+**Status codes**:
891 891
892 892 
 -   **204** – no error
893 893 
 -   **304** – container already stopped
... ... 
@@ -908,11 +907,11 @@ Restart the container `id`
908 908
909 909 
     HTTP/1.1 204 No Content
910 910
911 
-Query Parameters:
911 
+**Query parameters**:
912 912
913 913 
 -   **t** – number of seconds to wait before killing the container
914 914
915 
-Status Codes:
915 
+**Status codes**:
916 916
917 917 
 -   **204** – no error
918 918 
 -   **404** – no such container
... ... 
@@ -932,12 +931,12 @@ Kill the container `id`
932 932
933 933 
     HTTP/1.1 204 No Content
934 934
935 
-Query Parameters
935 
+**Query parameters**:
936 936
937 937 
 -   **signal** - Signal to send to the container: integer or string like `SIGINT`.
938 938 
         When not set, `SIGKILL` is assumed and the call waits for the container to exit.
939 939
940 
-Status Codes:
940 
+**Status codes**:
941 941
942 942 
 -   **204** – no error
943 943 
 -   **404** – no such container
... ... 
@@ -957,11 +956,11 @@ Rename the container `id` to a `new_name`
957 957
958 958 
     HTTP/1.1 204 No Content
959 959
960 
-Query Parameters:
960 
+**Query parameters**:
961 961
962 962 
 -   **name** – new name for the container
963 963
964 
-Status Codes:
964 
+**Status codes**:
965 965
966 966 
 -   **204** – no error
967 967 
 -   **404** – no such container
... ... 
@@ -982,7 +981,7 @@ Pause the container `id`
982 982
983 983 
     HTTP/1.1 204 No Content
984 984
985 
-Status Codes:
985 
+**Status codes**:
986 986
987 987 
 -   **204** – no error
988 988 
 -   **404** – no such container
... ... 
@@ -1002,7 +1001,7 @@ Unpause the container `id`
1002 1002
1003 1003 
     HTTP/1.1 204 No Content
1004 1004
1005 
-Status Codes:
1005 
+**Status codes**:
1006 1006
1007 1007 
 -   **204** – no error
1008 1008 
 -   **404** – no such container
... ... 
@@ -1027,7 +1026,7 @@ Attach to the container `id`
1027 1027
1028 1028 
     {{ STREAM }}
1029 1029
1030 
-Query Parameters:
1030 
+**Query parameters**:
1031 1031
1032 1032 
 -   **logs** – 1/True/true or 0/False/false, return logs. Default `false`.
1033 1033 
 -   **stream** – 1/True/true or 0/False/false, return stream.
... ... 
@@ -1039,7 +1038,7 @@ Query Parameters:
1039 1039 
 -   **stderr** – 1/True/true or 0/False/false, if `logs=true`, return
1040 1040 
         `stderr` log, if `stream=true`, attach to `stderr`. Default `false`.
1041 1041
1042 
-Status Codes:
1042 
+**Status codes**:
1043 1043
1044 1044 
 -   **101** – no error, hints proxy about hijacking
1045 1045 
 -   **200** – no error, no upgrade header found
... ... 
@@ -1107,7 +1106,7 @@ Implements websocket protocol handshake according to [RFC 6455](http://tools.iet
1107 1107
1108 1108 
     {{ STREAM }}
1109 1109
1110 
-Query Parameters:
1110 
+**Query parameters**:
1111 1111
1112 1112 
 -   **logs** – 1/True/true or 0/False/false, return logs. Default `false`.
1113 1113 
 -   **stream** – 1/True/true or 0/False/false, return stream.
... ... 
@@ -1119,7 +1118,7 @@ Query Parameters:
1119 1119 
 -   **stderr** – 1/True/true or 0/False/false, if `logs=true`, return
1120 1120 
         `stderr` log, if `stream=true`, attach to `stderr`. Default `false`.
1121 1121
1122 
-Status Codes:
1122 
+**Status codes**:
1123 1123
1124 1124 
 -   **200** – no error
1125 1125 
 -   **400** – bad parameter
... ... 
@@ -1143,7 +1142,7 @@ Block until container `id` stops, then returns the exit code
1143 1143
1144 1144 
     {"StatusCode": 0}
1145 1145
1146 
-Status Codes:
1146 
+**Status codes**:
1147 1147
1148 1148 
 -   **200** – no error
1149 1149 
 -   **404** – no such container
... ... 
@@ -1163,14 +1162,14 @@ Remove the container `id` from the filesystem
1163 1163
1164 1164 
     HTTP/1.1 204 No Content
1165 1165
1166 
-Query Parameters:
1166 
+**Query parameters**:
1167 1167
1168 1168 
 -   **v** – 1/True/true or 0/False/false, Remove the volumes
1169 1169 
         associated to the container. Default `false`.
1170 1170 
 -   **force** - 1/True/true or 0/False/false, Kill then remove the container.
1171 1171 
         Default `false`.
1172 1172
1173 
-Status Codes:
1173 
+**Status codes**:
1174 1174
1175 1175 
 -   **204** – no error
1176 1176 
 -   **400** – bad parameter
... ... 
@@ -1202,7 +1201,7 @@ Copy files or folders of container `id`
1202 1202
1203 1203 
     {{ TAR STREAM }}
1204 1204
1205 
-Status Codes:
1205 
+**Status codes**:
1206 1206
1207 1207 
 -   **200** – no error
1208 1208 
 -   **404** – no such container
... ... 
@@ -1221,7 +1220,7 @@ following section.
1221 1221
1222 1222 
 Get a tar archive of a resource in the filesystem of container `id`.
1223 1223
1224 
-Query Parameters:
1224 
+**Query parameters**:
1225 1225
1226 1226 
 - **path** - resource in the container's filesystem to archive. Required.
1227 1227
... ... 
@@ -1232,39 +1231,41 @@ Query Parameters:
1232 1232 
     indicates that only the contents of the **path** directory should be
1233 1233 
     copied. A symlink is always resolved to its target.
1234 1234
1235 
-    **Note**: It is not possible to copy certain system files such as resources
1236 
-    under `/proc`, `/sys`, `/dev`, and mounts created by the user in the
1237 
-    container.
1235 
+    > **Note**: It is not possible to copy certain system files such as resources
1236 
+    > under `/proc`, `/sys`, `/dev`, and mounts created by the user in the
1237 
+    > container.
1238 1238
1239 1239 
 **Example request**:
1240 1240
1241 
-        GET /containers/8cce319429b2/archive?path=/root HTTP/1.1
1241 
+    GET /containers/8cce319429b2/archive?path=/root HTTP/1.1
1242 1242
1243 1243 
 **Example response**:
1244 1244
1245 
-        HTTP/1.1 200 OK
1246 
-        Content-Type: application/x-tar
1247 
-        X-Docker-Container-Path-Stat: eyJuYW1lIjoicm9vdCIsInNpemUiOjQwOTYsIm1vZGUiOjIxNDc0ODQwOTYsIm10aW1lIjoiMjAxNC0wMi0yN1QyMDo1MToyM1oiLCJsaW5rVGFyZ2V0IjoiIn0=
1245 
+    HTTP/1.1 200 OK
1246 
+    Content-Type: application/x-tar
1247 
+    X-Docker-Container-Path-Stat: eyJuYW1lIjoicm9vdCIsInNpemUiOjQwOTYsIm1vZGUiOjIxNDc0ODQwOTYsIm10aW1lIjoiMjAxNC0wMi0yN1QyMDo1MToyM1oiLCJsaW5rVGFyZ2V0IjoiIn0=
1248 1248
1249 
-        {{ TAR STREAM }}
1249 
+    {{ TAR STREAM }}
1250 1250
1251 1251 
 On success, a response header `X-Docker-Container-Path-Stat` will be set to a
1252 1252 
 base64-encoded JSON object containing some filesystem header information about
1253 1253 
 the archived resource. The above example value would decode to the following
1254 1254 
 JSON object (whitespace added for readability):
1255 1255
1256 
-        {
1257 
-            "name": "root",
1258 
-            "size": 4096,
1259 
-            "mode": 2147484096,
1260 
-            "mtime": "2014-02-27T20:51:23Z",
1261 
-            "linkTarget": ""
1262 
-        }
1256 
+```json
1257 
+{
1258 
+    "name": "root",
1259 
+    "size": 4096,
1260 
+    "mode": 2147484096,
1261 
+    "mtime": "2014-02-27T20:51:23Z",
1262 
+    "linkTarget": ""
1263 
+}
1264 
+```
1263 1265
1264 1266 
 A `HEAD` request can also be made to this endpoint if only this information is
1265 1267 
 desired.
1266 1268
1267 
-Status Codes:
1269 
+**Status codes**:
1268 1270
1269 1271 
 - **200** - success, returns archive of copied resource
1270 1272 
 - **400** - client error, bad parameter, details in JSON response body, one of:
... ... 
@@ -1283,7 +1284,7 @@ Status Codes:
1283 1283 
 Upload a tar archive to be extracted to a path in the filesystem of container
1284 1284 
 `id`.
1285 1285
1286 
-Query Parameters:
1286 
+**Query parameters**:
1287 1287
1288 1288 
 - **path** - path to a directory in the container
1289 1289 
     to extract the archive's contents into. Required.
... ... 
@@ -1305,7 +1306,7 @@ Query Parameters:
1305 1305
1306 1306 
     HTTP/1.1 200 OK
1307 1307
1308 
-Status Codes:
1308 
+**Status codes**:
1309 1309
1310 1310 
 - **200** – the content was extracted successfully
1311 1311 
 - **400** - client error, bad parameter, details in JSON response body, one of:
... ... 
@@ -1407,7 +1408,7 @@ digest. You can reference this digest using the value:
1407 1407 
 See the `docker run` and `docker build` commands for examples of digest and tag
1408 1408 
 references on the command line.
1409 1409
1410 
-Query Parameters:
1410 
+**Query parameters**:
1411 1411
1412 1412 
 -   **all** – 1/True/true or 0/False/false, default false
1413 1413 
 -   **filters** – a JSON encoded value of the filters (a map[string][]string) to process on the images list. Available filters:
... ... 
@@ -1451,7 +1452,7 @@ command*](../../reference/builder.md#add)).
1451 1451 
 The build is canceled if the client drops the connection by quitting
1452 1452 
 or being killed.
1453 1453
1454 
-Query Parameters:
1454 
+**Query parameters**:
1455 1455
1456 1456 
 -   **dockerfile** - Path within the build context to the Dockerfile. This is
1457 1457 
         ignored if `remote` is specified and points to an individual filename.
... ... 
@@ -1460,7 +1461,7 @@ Query Parameters:
1460 1460 
         You can provide one or more `t` parameters.
1461 1461 
 -   **remote** – A Git repository URI or HTTP/HTTPS URI build source. If the
1462 1462 
         URI specifies a filename, the file's contents are placed into a file
1463 
-		called `Dockerfile`.
1463 
+        called `Dockerfile`.
1464 1464 
 -   **q** – Suppress verbose build output.
1465 1465 
 -   **nocache** – Do not use the cache when building the image.
1466 1466 
 -   **pull** - Attempt to pull the image even if an older image exists locally.
... ... 
@@ -1504,7 +1505,7 @@ Query Parameters:
1504 1504 
     be specified with both a "https://" prefix and a "/v1/" suffix even
1505 1505 
     though Docker will prefer to use the v2 registry API.
1506 1506
1507 
-Status Codes:
1507 
+**Status codes**:
1508 1508
1509 1509 
 -   **200** – no error
1510 1510 
 -   **500** – server error
... ... 
@@ -1533,7 +1534,7 @@ When using this endpoint to pull an image from the registry, the
1533 1533 
 `X-Registry-Auth` header can be used to include
1534 1534 
 a base64-encoded AuthConfig object.
1535 1535
1536 
-Query Parameters:
1536 
+**Query parameters**:
1537 1537
1538 1538 
 -   **fromImage** – Name of the image to pull. The name may include a tag or
1539 1539 
         digest. This parameter may only be used when pulling an image.
... ... 
@@ -1549,7 +1550,7 @@ Query Parameters:
1549 1549
1550 1550 
 -   **X-Registry-Auth** – base64-encoded AuthConfig object
1551 1551
1552 
-Status Codes:
1552 
+**Status codes**:
1553 1553
1554 1554 
 -   **200** – no error
1555 1555 
 -   **500** – server error
... ... 
@@ -1661,7 +1662,7 @@ Return low-level information on the image `name`
1661 1661 
        }
1662 1662 
     }
1663 1663
1664 
-Status Codes:
1664 
+**Status codes**:
1665 1665
1666 1666 
 -   **200** – no error
1667 1667 
 -   **404** – no such image
... ... 
@@ -1715,7 +1716,7 @@ Return the history of the image `name`
1715 1715 
         }
1716 1716 
     ]
1717 1717
1718 
-Status Codes:
1718 
+**Status codes**:
1719 1719
1720 1720 
 -   **200** – no error
1721 1721 
 -   **404** – no such image
... ... 
@@ -1750,7 +1751,7 @@ then be used in the URL. This duplicates the command line's flow.
1750 1750 
     POST /images/registry.acme.com:5000/test/push HTTP/1.1
1751 1751
1752 1752
1753 
-Query Parameters:
1753 
+**Query parameters**:
1754 1754
1755 1755 
 -   **tag** – The tag to associate with the image on the registry. This is optional.
1756 1756
... ... 
@@ -1759,7 +1760,7 @@ Request Headers:
1759 1759 
 -   **X-Registry-Auth** – Include a base64-encoded AuthConfig.
1760 1760 
         object.
1761 1761
1762 
-Status Codes:
1762 
+**Status codes**:
1763 1763
1764 1764 
 -   **200** – no error
1765 1765 
 -   **404** – no such image
... ... 
@@ -1779,13 +1780,13 @@ Tag the image `name` into a repository
1779 1779
1780 1780 
     HTTP/1.1 201 Created
1781 1781
1782 
-Query Parameters:
1782 
+**Query parameters**:
1783 1783
1784 1784 
 -   **repo** – The repository to tag in
1785 1785 
 -   **force** – 1/True/true or 0/False/false, default false
1786 1786 
 -   **tag** - The new tag name
1787 1787
1788 
-Status Codes:
1788 
+**Status codes**:
1789 1789
1790 1790 
 -   **201** – no error
1791 1791 
 -   **400** – bad parameter
... ... 
@@ -1814,12 +1815,12 @@ Remove the image `name` from the filesystem
1814 1814 
      {"Deleted": "53b4f83ac9"}
1815 1815 
     ]
1816 1816
1817 
-Query Parameters:
1817 
+**Query parameters**:
1818 1818
1819 1819 
 -   **force** – 1/True/true or 0/False/false, default false
1820 1820 
 -   **noprune** – 1/True/true or 0/False/false, default false
1821 1821
1822 
-Status Codes:
1822 
+**Status codes**:
1823 1823
1824 1824 
 -   **200** – no error
1825 1825 
 -   **404** – no such image
... ... 
@@ -1870,11 +1871,11 @@ Search for an image on [Docker Hub](https://hub.docker.com).
1870 1870 
     ...
1871 1871 
     ]
1872 1872
1873 
-Query Parameters:
1873 
+**Query parameters**:
1874 1874
1875 1875 
 -   **term** – term to search
1876 1876
1877 
-Status Codes:
1877 
+**Status codes**:
1878 1878
1879 1879 
 -   **200** – no error
1880 1880 
 -   **500** – server error
... ... 
@@ -1903,7 +1904,7 @@ Get the default username and email
1903 1903
1904 1904 
     HTTP/1.1 200 OK
1905 1905
1906 
-Status Codes:
1906 
+**Status codes**:
1907 1907
1908 1908 
 -   **200** – no error
1909 1909 
 -   **204** – no error
... ... 
@@ -1975,7 +1976,7 @@ Display system-wide information
1975 1975 
         "SystemTime": "2015-03-10T11:11:23.730591467-07:00"
1976 1976 
     }
1977 1977
1978 
-Status Codes:
1978 
+**Status codes**:
1979 1979
1980 1980 
 -   **200** – no error
1981 1981 
 -   **500** – server error
... ... 
@@ -2006,7 +2007,7 @@ Show the docker version information
2006 2006 
          "Experimental": false
2007 2007 
     }
2008 2008
2009 
-Status Codes:
2009 
+**Status codes**:
2010 2010
2011 2011 
 -   **200** – no error
2012 2012 
 -   **500** – server error
... ... 
@@ -2028,7 +2029,7 @@ Ping the docker server
2028 2028
2029 2029 
     OK
2030 2030
2031 
-Status Codes:
2031 
+**Status codes**:
2032 2032
2033 2033 
 -   **200** - no error
2034 2034 
 -   **500** - server error
... ... 
@@ -2084,11 +2085,11 @@ Create a new image from a container's changes
2084 2084
2085 2085 
     {"Id": "596069db4bf5"}
2086 2086
2087 
-Json Parameters:
2087 
+**JSON parameters**:
2088 2088
2089 2089 
 -  **config** - the container's configuration
2090 2090
2091 
-Query Parameters:
2091 
+**Query parameters**:
2092 2092
2093 2093 
 -   **container** – source container
2094 2094 
 -   **repo** – repository
... ... 
@@ -2099,7 +2100,7 @@ Query Parameters:
2099 2099 
 -   **pause** – 1/True/true or 0/False/false, whether to pause the container before committing
2100 2100 
 -   **changes** – Dockerfile instructions to apply while committing
2101 2101
2102 
-Status Codes:
2102 
+**Status codes**:
2103 2103
2104 2104 
 -   **201** – no error
2105 2105 
 -   **404** – no such container
... ... 
@@ -2134,7 +2135,7 @@ and Docker images report:
2134 2134 
     {"status":"attach","id":"5745704abe9caa5","from":"busybox","time":1442421716,"timeNano":1442421716894759198}
2135 2135 
     {"status":"start","id":"5745704abe9caa5","from":"busybox","time":1442421716,"timeNano":1442421716983607193}
2136 2136
2137 
-Query Parameters:
2137 
+**Query parameters**:
2138 2138
2139 2139 
 -   **since** – Timestamp used for polling
2140 2140 
 -   **until** – Timestamp used for polling
... ... 
@@ -2144,7 +2145,7 @@ Query Parameters:
2144 2144 
   -   `image=<string>`; -- image to filter
2145 2145 
   -   `label=<string>`; -- image and container label to filter
2146 2146
2147 
-Status Codes:
2147 
+**Status codes**:
2148 2148
2149 2149 
 -   **200** – no error
2150 2150 
 -   **500** – server error
... ... 
@@ -2174,7 +2175,7 @@ See the [image tarball format](#image-tarball-format) for more details.
2174 2174
2175 2175 
     Binary data stream
2176 2176
2177 
-Status Codes:
2177 
+**Status codes**:
2178 2178
2179 2179 
 -   **200** – no error
2180 2180 
 -   **500** – server error
... ... 
@@ -2203,7 +2204,7 @@ See the [image tarball format](#image-tarball-format) for more details.
2203 2203
2204 2204 
     Binary data stream
2205 2205
2206 
-Status Codes:
2206 
+**Status codes**:
2207 2207
2208 2208 
 -   **200** – no error
2209 2209 
 -   **500** – server error
... ... 
@@ -2225,7 +2226,7 @@ See the [image tarball format](#image-tarball-format) for more details.
2225 2225
2226 2226 
     HTTP/1.1 200 OK
2227 2227
2228 
-Status Codes:
2228 
+**Status codes**:
2229 2229
2230 2230 
 -   **200** – no error
2231 2231 
 -   **500** – server error
... ... 
@@ -2282,7 +2283,7 @@ Sets up an exec instance in a running container `id`
2282 2282 
          "Warnings":[]
2283 2283 
     }
2284 2284
2285 
-Json Parameters:
2285 
+**JSON parameters**:
2286 2286
2287 2287 
 -   **AttachStdin** - Boolean value, attaches to `stdin` of the `exec` command.
2288 2288 
 -   **AttachStdout** - Boolean value, attaches to `stdout` of the `exec` command.
... ... 
@@ -2291,7 +2292,7 @@ Json Parameters:
2291 2291 
 -   **Cmd** - Command to run specified as a string or an array of strings.
2292 2292
2293 2293
2294 
-Status Codes:
2294 
+**Status codes**:
2295 2295
2296 2296 
 -   **201** – no error
2297 2297 
 -   **404** – no such container
... ... 
@@ -2323,12 +2324,12 @@ interactive session with the `exec` command.
2323 2323
2324 2324 
     {{ STREAM }}
2325 2325
2326 
-Json Parameters:
2326 
+**JSON parameters**:
2327 2327
2328 2328 
 -   **Detach** - Detach from the `exec` command.
2329 2329 
 -   **Tty** - Boolean value to allocate a pseudo-TTY.
2330 2330
2331 
-Status Codes:
2331 
+**Status codes**:
2332 2332
2333 2333 
 -   **200** – no error
2334 2334 
 -   **404** – no such exec instance
... ... 
@@ -2354,12 +2355,12 @@ This API is valid only if `tty` was specified as part of creating and starting t
2354 2354 
     HTTP/1.1 201 Created
2355 2355 
     Content-Type: text/plain
2356 2356
2357 
-Query Parameters:
2357 
+**Query parameters**:
2358 2358
2359 2359 
 -   **h** – height of `tty` session
2360 2360 
 -   **w** – width
2361 2361
2362 
-Status Codes:
2362 
+**Status codes**:
2363 2363
2364 2364 
 -   **201** – no error
2365 2365 
 -   **404** – no such exec instance
... ... 
@@ -2484,7 +2485,7 @@ Return low-level information about the `exec` command `id`.
2484 2484 
       }
2485 2485 
     }
2486 2486
2487 
-Status Codes:
2487 
+**Status codes**:
2488 2488
2489 2489 
 -   **200** – no error
2490 2490 
 -   **404** – no such exec instance
... ... 
@@ -2515,11 +2516,11 @@ Status Codes:
2515 2515 
       ]
2516 2516 
     }
2517 2517
2518 
-Query Parameters:
2518 
+**Query parameters**:
2519 2519
2520 2520 
 - **filters** - JSON encoded value of the filters (a `map[string][]string`) to process on the volumes list. There is one available filter: `dangling=true`
2521 2521
2522 
-Status Codes:
2522 
+**Status codes**:
2523 2523
2524 2524 
 -   **200** - no error
2525 2525 
 -   **500** - server error
... ... 
@@ -2550,12 +2551,12 @@ Create a volume
2550 2550 
       "Mountpoint": "/var/lib/docker/volumes/tardis"
2551 2551 
     }
2552 2552
2553 
-Status Codes:
2553 
+**Status codes**:
2554 2554
2555 2555 
 - **201** - no error
2556 2556 
 - **500**  - server error
2557 2557
2558 
-JSON Parameters:
2558 
+**JSON parameters**:
2559 2559
2560 2560 
 - **Name** - The new volume's name. If not specified, Docker generates a name.
2561 2561 
 - **Driver** - Name of the volume driver to use. Defaults to `local` for the name.
... ... 
@@ -2583,7 +2584,7 @@ Return low-level information on the volume `name`
2583 2583 
       "Mountpoint": "/var/lib/docker/volumes/tardis"
2584 2584 
     }
2585 2585
2586 
-Status Codes:
2586 
+**Status codes**:
2587 2587
2588 2588 
 -   **200** - no error
2589 2589 
 -   **404** - no such volume
... ... 
@@ -2603,7 +2604,7 @@ Instruct the driver to remove the volume (`name`).
2603 2603
2604 2604 
     HTTP/1.1 204 No Content
2605 2605
2606 
-Status Codes
2606 
+**Status codes**:
2607 2607
2608 2608 
 -   **204** - no error
2609 2609 
 -   **404** - no such volume or volume driver
... ... 
@@ -2684,13 +2685,11 @@ Content-Type: application/json
2684 2684 
 ]
2685 2685 
 ```
2686 2686
2687 
-
2688 
-
2689 
-Query Parameters:
2687 
+**Query parameters**:
2690 2688
2691 2689 
 - **filters** - JSON encoded value of the filters (a `map[string][]string`) to process on the networks list. Available filters: `name=[network-names]` , `id=[network-ids]`
2692 2690
2693 
-Status Codes:
2691 
+**Status codes**:
2694 2692
2695 2693 
 -   **200** - no error
2696 2694 
 -   **500** - server error
... ... 
@@ -2741,7 +2740,7 @@ Content-Type: application/json
2741 2741 
 }
2742 2742 
 ```
2743 2743
2744 
-Status Codes:
2744 
+**Status codes**:
2745 2745
2746 2746 
 -   **200** - no error
2747 2747 
 -   **404** - network not found
... ... 
@@ -2760,7 +2759,7 @@ Content-Type: application/json
2760 2760
2761 2761 
 {
2762 2762 
   "Name":"isolated_nw",
2763 
-  "Driver":"bridge"
2763 
+  "Driver":"bridge",
2764 2764 
   "IPAM":{
2765 2765 
     "Config":[{
2766 2766 
       "Subnet":"172.20.0.0/16",
... ... 
@@ -2782,13 +2781,13 @@ Content-Type: application/json
2782 2782 
 }
2783 2783 
 ```
2784 2784
2785 
-Status Codes:
2785 
+**Status codes**:
2786 2786
2787 2787 
 - **201** - no error
2788 2788 
 - **404** - plugin not found
2789 2789 
 - **500** - server error
2790 2790
2791 
-JSON Parameters:
2791 
+**JSON parameters**:
2792 2792
2793 2793 
 - **Name** - The new network's name. this is a mandatory field
2794 2794 
 - **Driver** - Name of the network driver plugin to use. Defaults to `bridge` driver
... ... 
@@ -2817,13 +2816,13 @@ Content-Type: application/json
2817 2817
2818 2818 
     HTTP/1.1 200 OK
2819 2819
2820 
-Status Codes:
2820 
+**Status codes**:
2821 2821
2822 2822 
 - **200** - no error
2823 2823 
 - **404** - network or container is not found
2824 2824 
 - **500** - Internal Server Error
2825 2825
2826 
-JSON Parameters:
2826 
+**JSON parameters**:
2827 2827
2828 2828 
 - **container** - container-id/name to be connected to the network
2829 2829
... ... 
@@ -2848,13 +2847,13 @@ Content-Type: application/json
2848 2848
2849 2849 
     HTTP/1.1 200 OK
2850 2850
2851 
-Status Codes:
2851 
+**Status codes**:
2852 2852
2853 2853 
 - **200** - no error
2854 2854 
 - **404** - network or container not found
2855 2855 
 - **500** - Internal Server Error
2856 2856
2857 
-JSON Parameters:
2857 
+**JSON parameters**:
2858 2858
2859 2859 
 - **Container** - container-id/name to be disconnected from a network
2860 2860
... ... 
@@ -2872,7 +2871,7 @@ Instruct the driver to remove the network (`id`).
2872 2872
2873 2873 
     HTTP/1.1 200 OK
2874 2874
2875 
-Status Codes
2875 
+**Status codes**:
2876 2876
2877 2877 
 -   **200** - no error
2878 2878 
 -   **404** - no such network
docs/reference/api/docker_remote_api_v1.22.md
History View file @ 0194094
... ... 
@@ -187,7 +187,7 @@ List containers
187 187 
          }
188 188 
     ]
189 189
190 
-Query Parameters:
190 
+**Query parameters**:
191 191
192 192 
 -   **all** – 1/True/true or 0/False/false, Show all containers.
193 193 
         Only running containers are shown by default (i.e., this defaults to false)
... ... 
@@ -205,7 +205,7 @@ Query Parameters:
205 205 
   -   `label=key` or `label="key=value"` of a container label
206 206 
   -   `isolation=`(`default`|`process`|`hyperv`)   (Windows daemon only)
207 207
208 
-Status Codes:
208 
+**Status codes**:
209 209
210 210 
 -   **200** – no error
211 211 
 -   **400** – bad parameter
... ... 
@@ -324,7 +324,7 @@ Create a container
324 324 
            "Warnings":[]
325 325 
       }
326 326
327 
-Json Parameters:
327 
+**JSON parameters**:
328 328
329 329 
 -   **Hostname** - A string value containing the hostname to use for the
330 330 
       container.
... ... 
@@ -435,12 +435,12 @@ Json Parameters:
435 435 
     -   **VolumeDriver** - Driver that this container users to mount volumes.
436 436 
     -   **ShmSize** - Size of `/dev/shm` in bytes. The size must be greater than 0.  If omitted the system uses 64MB.
437 437
438 
-Query Parameters:
438 
+**Query parameters**:
439 439
440 440 
 -   **name** – Assign the specified name to the container. Must
441 441 
     match `/?[a-zA-Z0-9_-]+`.
442 442
443 
-Status Codes:
443 
+**Status codes**:
444 444
445 445 
 -   **201** – no error
446 446 
 -   **400** – bad parameter
... ... 
@@ -455,7 +455,6 @@ Status Codes:
455 455
456 456 
 Return low-level information on the container `id`
457 457
458 
-
459 458 
 **Example request**:
460 459
461 460 
       GET /containers/4fa6e0f0c678/json HTTP/1.1
... ... 
@@ -501,8 +500,8 @@ Return low-level information on the container `id`
501 501 
 			"Tty": false,
502 502 
 			"User": "",
503 503 
 			"Volumes": {
504 
-                          "/volumes/data": {}
505 
-                        },
504 
+				"/volumes/data": {}
505 
+			},
506 506 
 			"WorkingDir": "",
507 507 
 			"StopSignal": "SIGTERM"
508 508 
 		},
... ... 
@@ -643,11 +642,11 @@ Return low-level information on the container `id`
643 643 
     ....
644 644 
     }
645 645
646 
-Query Parameters:
646 
+**Query parameters**:
647 647
648 648 
 -   **size** – 1/True/true or 0/False/false, return container size information. Default is `false`.
649 649
650 
-Status Codes:
650 
+**Status codes**:
651 651
652 652 
 -   **200** – no error
653 653 
 -   **404** – no such container
... ... 
@@ -707,11 +706,11 @@ supported on Windows.
707 707 
       ],
708 708 
     }
709 709
710 
-Query Parameters:
710 
+**Query parameters**:
711 711
712 712 
 -   **ps_args** – `ps` arguments to use (e.g., `aux`), defaults to `-ef`
713 713
714 
-Status Codes:
714 
+**Status codes**:
715 715
716 716 
 -   **200** – no error
717 717 
 -   **404** – no such container
... ... 
@@ -739,7 +738,7 @@ Get `stdout` and `stderr` logs from the container ``id``
739 739
740 740 
      {{ STREAM }}
741 741
742 
-Query Parameters:
742 
+**Query parameters**:
743 743
744 744 
 -   **follow** – 1/True/true or 0/False/false, return stream. Default `false`.
745 745 
 -   **stdout** – 1/True/true or 0/False/false, show `stdout` log. Default `false`.
... ... 
@@ -750,7 +749,7 @@ Query Parameters:
750 750 
         every log line. Default `false`.
751 751 
 -   **tail** – Output specified number of lines at the end of logs: `all` or `<number>`. Default all.
752 752
753 
-Status Codes:
753 
+**Status codes**:
754 754
755 755 
 -   **101** – no error, hints proxy about hijacking
756 756 
 -   **200** – no error, no upgrade header found
... ... 
@@ -793,7 +792,7 @@ Values for `Kind`:
793 793 
 - `1`: Add
794 794 
 - `2`: Delete
795 795
796 
-Status Codes:
796 
+**Status codes**:
797 797
798 798 
 -   **200** – no error
799 799 
 -   **404** – no such container
... ... 
@@ -816,7 +815,7 @@ Export the contents of container `id`
816 816
817 817 
     {{ TAR STREAM }}
818 818
819 
-Status Codes:
819 
+**Status codes**:
820 820
821 821 
 -   **200** – no error
822 822 
 -   **404** – no such container
... ... 
@@ -933,11 +932,11 @@ This endpoint returns a live stream of a container's resource usage statistics.
933 933
934 934 
 The precpu_stats is the cpu statistic of last read, which is used for calculating the cpu usage percent. It is not the exact copy of the “cpu_stats” field.
935 935
936 
-Query Parameters:
936 
+**Query parameters**:
937 937
938 938 
 -   **stream** – 1/True/true or 0/False/false, pull stats once then disconnect. Default `true`.
939 939
940 
-Status Codes:
940 
+**Status codes**:
941 941
942 942 
 -   **200** – no error
943 943 
 -   **404** – no such container
... ... 
@@ -959,12 +958,12 @@ Resize the TTY for container with  `id`. The unit is number of characters. You m
959 959 
       Content-Length: 0
960 960 
       Content-Type: text/plain; charset=utf-8
961 961
962 
-Query Parameters:
962 
+**Query parameters**:
963 963
964 964 
 -   **h** – height of `tty` session
965 965 
 -   **w** – width
966 966
967 
-Status Codes:
967 
+**Status codes**:
968 968
969 969 
 -   **200** – no error
970 970 
 -   **404** – No such container
... ... 
@@ -988,13 +987,13 @@ Start the container `id`
988 988
989 989 
     HTTP/1.1 204 No Content
990 990
991 
-Query Parameters:
991 
+**Query parameters**:
992 992
993 993 
 -   **detachKeys** – Override the key sequence for detaching a
994 994 
         container. Format is a single character `[a-Z]` or `ctrl-<value>`
995 995 
         where `<value>` is one of: `a-z`, `@`, `^`, `[`, `,` or `_`.
996 996
997 
-Status Codes:
997 
+**Status codes**:
998 998
999 999 
 -   **204** – no error
1000 1000 
 -   **304** – container already started
... ... 
@@ -1015,11 +1014,11 @@ Stop the container `id`
1015 1015
1016 1016 
     HTTP/1.1 204 No Content
1017 1017
1018 
-Query Parameters:
1018 
+**Query parameters**:
1019 1019
1020 1020 
 -   **t** – number of seconds to wait before killing the container
1021 1021
1022 
-Status Codes:
1022 
+**Status codes**:
1023 1023
1024 1024 
 -   **204** – no error
1025 1025 
 -   **304** – container already stopped
... ... 
@@ -1040,11 +1039,11 @@ Restart the container `id`
1040 1040
1041 1041 
     HTTP/1.1 204 No Content
1042 1042
1043 
-Query Parameters:
1043 
+**Query parameters**:
1044 1044
1045 1045 
 -   **t** – number of seconds to wait before killing the container
1046 1046
1047 
-Status Codes:
1047 
+**Status codes**:
1048 1048
1049 1049 
 -   **204** – no error
1050 1050 
 -   **404** – no such container
... ... 
@@ -1064,12 +1063,12 @@ Kill the container `id`
1064 1064
1065 1065 
     HTTP/1.1 204 No Content
1066 1066
1067 
-Query Parameters
1067 
+**Query parameters**:
1068 1068
1069 1069 
 -   **signal** - Signal to send to the container: integer or string like `SIGINT`.
1070 1070 
         When not set, `SIGKILL` is assumed and the call waits for the container to exit.
1071 1071
1072 
-Status Codes:
1072 
+**Status codes**:
1073 1073
1074 1074 
 -   **204** – no error
1075 1075 
 -   **404** – no such container
... ... 
@@ -1108,7 +1107,7 @@ Update resource configs of one or more containers.
1108 1108 
            "Warnings": []
1109 1109 
        }
1110 1110
1111 
-Status Codes:
1111 
+**Status codes**:
1112 1112
1113 1113 
 -   **200** – no error
1114 1114 
 -   **400** – bad parameter
... ... 
@@ -1129,11 +1128,11 @@ Rename the container `id` to a `new_name`
1129 1129
1130 1130 
     HTTP/1.1 204 No Content
1131 1131
1132 
-Query Parameters:
1132 
+**Query parameters**:
1133 1133
1134 1134 
 -   **name** – new name for the container
1135 1135
1136 
-Status Codes:
1136 
+**Status codes**:
1137 1137
1138 1138 
 -   **204** – no error
1139 1139 
 -   **404** – no such container
... ... 
@@ -1154,7 +1153,7 @@ Pause the container `id`
1154 1154
1155 1155 
     HTTP/1.1 204 No Content
1156 1156
1157 
-Status Codes:
1157 
+**Status codes**:
1158 1158
1159 1159 
 -   **204** – no error
1160 1160 
 -   **404** – no such container
... ... 
@@ -1174,7 +1173,7 @@ Unpause the container `id`
1174 1174
1175 1175 
     HTTP/1.1 204 No Content
1176 1176
1177 
-Status Codes:
1177 
+**Status codes**:
1178 1178
1179 1179 
 -   **204** – no error
1180 1180 
 -   **404** – no such container
... ... 
@@ -1199,7 +1198,7 @@ Attach to the container `id`
1199 1199
1200 1200 
     {{ STREAM }}
1201 1201
1202 
-Query Parameters:
1202 
+**Query parameters**:
1203 1203
1204 1204 
 -   **detachKeys** – Override the key sequence for detaching a
1205 1205 
         container. Format is a single character `[a-Z]` or `ctrl-<value>`
... ... 
@@ -1214,7 +1213,7 @@ Query Parameters:
1214 1214 
 -   **stderr** – 1/True/true or 0/False/false, if `logs=true`, return
1215 1215 
         `stderr` log, if `stream=true`, attach to `stderr`. Default `false`.
1216 1216
1217 
-Status Codes:
1217 
+**Status codes**:
1218 1218
1219 1219 
 -   **101** – no error, hints proxy about hijacking
1220 1220 
 -   **200** – no error, no upgrade header found
... ... 
@@ -1283,7 +1282,7 @@ Implements websocket protocol handshake according to [RFC 6455](http://tools.iet
1283 1283
1284 1284 
     {{ STREAM }}
1285 1285
1286 
-Query Parameters:
1286 
+**Query parameters**:
1287 1287
1288 1288 
 -   **detachKeys** – Override the key sequence for detaching a
1289 1289 
         container. Format is a single character `[a-Z]` or `ctrl-<value>`
... ... 
@@ -1298,7 +1297,7 @@ Query Parameters:
1298 1298 
 -   **stderr** – 1/True/true or 0/False/false, if `logs=true`, return
1299 1299 
         `stderr` log, if `stream=true`, attach to `stderr`. Default `false`.
1300 1300
1301 
-Status Codes:
1301 
+**Status codes**:
1302 1302
1303 1303 
 -   **200** – no error
1304 1304 
 -   **400** – bad parameter
... ... 
@@ -1322,7 +1321,7 @@ Block until container `id` stops, then returns the exit code
1322 1322
1323 1323 
     {"StatusCode": 0}
1324 1324
1325 
-Status Codes:
1325 
+**Status codes**:
1326 1326
1327 1327 
 -   **200** – no error
1328 1328 
 -   **404** – no such container
... ... 
@@ -1342,14 +1341,14 @@ Remove the container `id` from the filesystem
1342 1342
1343 1343 
     HTTP/1.1 204 No Content
1344 1344
1345 
-Query Parameters:
1345 
+**Query parameters**:
1346 1346
1347 1347 
 -   **v** – 1/True/true or 0/False/false, Remove the volumes
1348 1348 
         associated to the container. Default `false`.
1349 1349 
 -   **force** - 1/True/true or 0/False/false, Kill then remove the container.
1350 1350 
         Default `false`.
1351 1351
1352 
-Status Codes:
1352 
+**Status codes**:
1353 1353
1354 1354 
 -   **204** – no error
1355 1355 
 -   **400** – bad parameter
... ... 
@@ -1381,7 +1380,7 @@ Copy files or folders of container `id`
1381 1381
1382 1382 
     {{ TAR STREAM }}
1383 1383
1384 
-Status Codes:
1384 
+**Status codes**:
1385 1385
1386 1386 
 -   **200** – no error
1387 1387 
 -   **404** – no such container
... ... 
@@ -1400,7 +1399,7 @@ following section.
1400 1400
1401 1401 
 Get a tar archive of a resource in the filesystem of container `id`.
1402 1402
1403 
-Query Parameters:
1403 
+**Query parameters**:
1404 1404
1405 1405 
 - **path** - resource in the container's filesystem to archive. Required.
1406 1406
... ... 
@@ -1411,39 +1410,41 @@ Query Parameters:
1411 1411 
     indicates that only the contents of the **path** directory should be
1412 1412 
     copied. A symlink is always resolved to its target.
1413 1413
1414 
-    **Note**: It is not possible to copy certain system files such as resources
1415 
-    under `/proc`, `/sys`, `/dev`, and mounts created by the user in the
1416 
-    container.
1414 
+    > **Note**: It is not possible to copy certain system files such as resources
1415 
+    > under `/proc`, `/sys`, `/dev`, and mounts created by the user in the
1416 
+    > container.
1417 1417
1418 1418 
 **Example request**:
1419 1419
1420 
-        GET /containers/8cce319429b2/archive?path=/root HTTP/1.1
1420 
+    GET /containers/8cce319429b2/archive?path=/root HTTP/1.1
1421 1421
1422 1422 
 **Example response**:
1423 1423
1424 
-        HTTP/1.1 200 OK
1425 
-        Content-Type: application/x-tar
1426 
-        X-Docker-Container-Path-Stat: eyJuYW1lIjoicm9vdCIsInNpemUiOjQwOTYsIm1vZGUiOjIxNDc0ODQwOTYsIm10aW1lIjoiMjAxNC0wMi0yN1QyMDo1MToyM1oiLCJsaW5rVGFyZ2V0IjoiIn0=
1424 
+    HTTP/1.1 200 OK
1425 
+    Content-Type: application/x-tar
1426 
+    X-Docker-Container-Path-Stat: eyJuYW1lIjoicm9vdCIsInNpemUiOjQwOTYsIm1vZGUiOjIxNDc0ODQwOTYsIm10aW1lIjoiMjAxNC0wMi0yN1QyMDo1MToyM1oiLCJsaW5rVGFyZ2V0IjoiIn0=
1427 1427
1428 
-        {{ TAR STREAM }}
1428 
+    {{ TAR STREAM }}
1429 1429
1430 1430 
 On success, a response header `X-Docker-Container-Path-Stat` will be set to a
1431 1431 
 base64-encoded JSON object containing some filesystem header information about
1432 1432 
 the archived resource. The above example value would decode to the following
1433 1433 
 JSON object (whitespace added for readability):
1434 1434
1435 
-        {
1436 
-            "name": "root",
1437 
-            "size": 4096,
1438 
-            "mode": 2147484096,
1439 
-            "mtime": "2014-02-27T20:51:23Z",
1440 
-            "linkTarget": ""
1441 
-        }
1435 
+```json
1436 
+{
1437 
+    "name": "root",
1438 
+    "size": 4096,
1439 
+    "mode": 2147484096,
1440 
+    "mtime": "2014-02-27T20:51:23Z",
1441 
+    "linkTarget": ""
1442 
+}
1443 
+```
1442 1444
1443 1445 
 A `HEAD` request can also be made to this endpoint if only this information is
1444 1446 
 desired.
1445 1447
1446 
-Status Codes:
1448 
+**Status codes**:
1447 1449
1448 1450 
 - **200** - success, returns archive of copied resource
1449 1451 
 - **400** - client error, bad parameter, details in JSON response body, one of:
... ... 
@@ -1462,7 +1463,7 @@ Status Codes:
1462 1462 
 Upload a tar archive to be extracted to a path in the filesystem of container
1463 1463 
 `id`.
1464 1464
1465 
-Query Parameters:
1465 
+**Query parameters**:
1466 1466
1467 1467 
 - **path** - path to a directory in the container
1468 1468 
     to extract the archive's contents into. Required.
... ... 
@@ -1484,7 +1485,7 @@ Query Parameters:
1484 1484
1485 1485 
     HTTP/1.1 200 OK
1486 1486
1487 
-Status Codes:
1487 
+**Status codes**:
1488 1488
1489 1489 
 - **200** – the content was extracted successfully
1490 1490 
 - **400** - client error, bad parameter, details in JSON response body, one of:
... ... 
@@ -1586,7 +1587,7 @@ digest. You can reference this digest using the value:
1586 1586 
 See the `docker run` and `docker build` commands for examples of digest and tag
1587 1587 
 references on the command line.
1588 1588
1589 
-Query Parameters:
1589 
+**Query parameters**:
1590 1590
1591 1591 
 -   **all** – 1/True/true or 0/False/false, default false
1592 1592 
 -   **filters** – a JSON encoded value of the filters (a map[string][]string) to process on the images list. Available filters:
... ... 
@@ -1630,7 +1631,7 @@ command*](../../reference/builder.md#add)).
1630 1630 
 The build is canceled if the client drops the connection by quitting
1631 1631 
 or being killed.
1632 1632
1633 
-Query Parameters:
1633 
+**Query parameters**:
1634 1634
1635 1635 
 -   **dockerfile** - Path within the build context to the Dockerfile. This is
1636 1636 
         ignored if `remote` is specified and points to an individual filename.
... ... 
@@ -1639,7 +1640,7 @@ Query Parameters:
1639 1639 
         You can provide one or more `t` parameters.
1640 1640 
 -   **remote** – A Git repository URI or HTTP/HTTPS URI build source. If the
1641 1641 
         URI specifies a filename, the file's contents are placed into a file
1642 
-		called `Dockerfile`.
1642 
+        called `Dockerfile`.
1643 1643 
 -   **q** – Suppress verbose build output.
1644 1644 
 -   **nocache** – Do not use the cache when building the image.
1645 1645 
 -   **pull** - Attempt to pull the image even if an older image exists locally.
... ... 
@@ -1684,7 +1685,7 @@ Query Parameters:
1684 1684 
     be specified with both a "https://" prefix and a "/v1/" suffix even
1685 1685 
     though Docker will prefer to use the v2 registry API.
1686 1686
1687 
-Status Codes:
1687 
+**Status codes**:
1688 1688
1689 1689 
 -   **200** – no error
1690 1690 
 -   **500** – server error
... ... 
@@ -1713,7 +1714,7 @@ When using this endpoint to pull an image from the registry, the
1713 1713 
 `X-Registry-Auth` header can be used to include
1714 1714 
 a base64-encoded AuthConfig object.
1715 1715
1716 
-Query Parameters:
1716 
+**Query parameters**:
1717 1717
1718 1718 
 -   **fromImage** – Name of the image to pull. The name may include a tag or
1719 1719 
         digest. This parameter may only be used when pulling an image.
... ... 
@@ -1747,7 +1748,7 @@ Query Parameters:
1747 1747 
     }
1748 1748 
         ```
1749 1749
1750 
-Status Codes:
1750 
+**Status codes**:
1751 1751
1752 1752 
 -   **200** – no error
1753 1753 
 -   **500** – server error
... ... 
@@ -1859,7 +1860,7 @@ Return low-level information on the image `name`
1859 1859 
        }
1860 1860 
     }
1861 1861
1862 
-Status Codes:
1862 
+**Status codes**:
1863 1863
1864 1864 
 -   **200** – no error
1865 1865 
 -   **404** – no such image
... ... 
@@ -1913,7 +1914,7 @@ Return the history of the image `name`
1913 1913 
         }
1914 1914 
     ]
1915 1915
1916 
-Status Codes:
1916 
+**Status codes**:
1917 1917
1918 1918 
 -   **200** – no error
1919 1919 
 -   **404** – no such image
... ... 
@@ -1950,7 +1951,7 @@ The push is cancelled if the HTTP connection is closed.
1950 1950 
     POST /images/registry.acme.com:5000/test/push HTTP/1.1
1951 1951
1952 1952
1953 
-Query Parameters:
1953 
+**Query parameters**:
1954 1954
1955 1955 
 -   **tag** – The tag to associate with the image on the registry. This is optional.
1956 1956
... ... 
@@ -1975,7 +1976,7 @@ Request Headers:
1975 1975 
     }
1976 1976 
         ```
1977 1977
1978 
-Status Codes:
1978 
+**Status codes**:
1979 1979
1980 1980 
 -   **200** – no error
1981 1981 
 -   **404** – no such image
... ... 
@@ -1995,13 +1996,13 @@ Tag the image `name` into a repository
1995 1995
1996 1996 
     HTTP/1.1 201 Created
1997 1997
1998 
-Query Parameters:
1998 
+**Query parameters**:
1999 1999
2000 2000 
 -   **repo** – The repository to tag in
2001 2001 
 -   **force** – 1/True/true or 0/False/false, default false
2002 2002 
 -   **tag** - The new tag name
2003 2003
2004 
-Status Codes:
2004 
+**Status codes**:
2005 2005
2006 2006 
 -   **201** – no error
2007 2007 
 -   **400** – bad parameter
... ... 
@@ -2030,12 +2031,12 @@ Remove the image `name` from the filesystem
2030 2030 
      {"Deleted": "53b4f83ac9"}
2031 2031 
     ]
2032 2032
2033 
-Query Parameters:
2033 
+**Query parameters**:
2034 2034
2035 2035 
 -   **force** – 1/True/true or 0/False/false, default false
2036 2036 
 -   **noprune** – 1/True/true or 0/False/false, default false
2037 2037
2038 
-Status Codes:
2038 
+**Status codes**:
2039 2039
2040 2040 
 -   **200** – no error
2041 2041 
 -   **404** – no such image
... ... 
@@ -2086,11 +2087,11 @@ Search for an image on [Docker Hub](https://hub.docker.com).
2086 2086 
     ...
2087 2087 
     ]
2088 2088
2089 
-Query Parameters:
2089 
+**Query parameters**:
2090 2090
2091 2091 
 -   **term** – term to search
2092 2092
2093 
-Status Codes:
2093 
+**Status codes**:
2094 2094
2095 2095 
 -   **200** – no error
2096 2096 
 -   **500** – server error
... ... 
@@ -2119,7 +2120,7 @@ Get the default username and email
2119 2119
2120 2120 
     HTTP/1.1 200 OK
2121 2121
2122 
-Status Codes:
2122 
+**Status codes**:
2123 2123
2124 2124 
 -   **200** – no error
2125 2125 
 -   **204** – no error
... ... 
@@ -2207,7 +2208,7 @@ Display system-wide information
2207 2207 
         "SystemTime": "2015-03-10T11:11:23.730591467-07:00"
2208 2208 
     }
2209 2209
2210 
-Status Codes:
2210 
+**Status codes**:
2211 2211
2212 2212 
 -   **200** – no error
2213 2213 
 -   **500** – server error
... ... 
@@ -2239,7 +2240,7 @@ Show the docker version information
2239 2239 
          "Experimental": true
2240 2240 
     }
2241 2241
2242 
-Status Codes:
2242 
+**Status codes**:
2243 2243
2244 2244 
 -   **200** – no error
2245 2245 
 -   **500** – server error
... ... 
@@ -2261,7 +2262,7 @@ Ping the docker server
2261 2261
2262 2262 
     OK
2263 2263
2264 
-Status Codes:
2264 
+**Status codes**:
2265 2265
2266 2266 
 -   **200** - no error
2267 2267 
 -   **500** - server error
... ... 
@@ -2317,11 +2318,11 @@ Create a new image from a container's changes
2317 2317
2318 2318 
     {"Id": "596069db4bf5"}
2319 2319
2320 
-Json Parameters:
2320 
+**JSON parameters**:
2321 2321
2322 2322 
 -  **config** - the container's configuration
2323 2323
2324 
-Query Parameters:
2324 
+**Query parameters**:
2325 2325
2326 2326 
 -   **container** – source container
2327 2327 
 -   **repo** – repository
... ... 
@@ -2332,7 +2333,7 @@ Query Parameters:
2332 2332 
 -   **pause** – 1/True/true or 0/False/false, whether to pause the container before committing
2333 2333 
 -   **changes** – Dockerfile instructions to apply while committing
2334 2334
2335 
-Status Codes:
2335 
+**Status codes**:
2336 2336
2337 2337 
 -   **201** – no error
2338 2338 
 -   **404** – no such container
... ... 
@@ -2520,7 +2521,7 @@ Docker networks report the following events:
2520 2520 
       "timeNano": 1461943105338056026
2521 2521 
     }
2522 2522
2523 
-Query Parameters:
2523 
+**Query parameters**:
2524 2524
2525 2525 
 -   **since** – Timestamp used for polling
2526 2526 
 -   **until** – Timestamp used for polling
... ... 
@@ -2533,7 +2534,7 @@ Query Parameters:
2533 2533 
   -   `volume=<string>`; -- volume to filter
2534 2534 
   -   `network=<string>`; -- network to filter
2535 2535
2536 
-Status Codes:
2536 
+**Status codes**:
2537 2537
2538 2538 
 -   **200** – no error
2539 2539 
 -   **500** – server error
... ... 
@@ -2563,12 +2564,12 @@ See the [image tarball format](#image-tarball-format) for more details.
2563 2563
2564 2564 
     Binary data stream
2565 2565
2566 
-Status Codes:
2566 
+**Status codes**:
2567 2567
2568 2568 
 -   **200** – no error
2569 2569 
 -   **500** – server error
2570 2570
2571 
-### Get a tarball containing all images.
2571 
+### Get a tarball containing all images
2572 2572
2573 2573 
 `GET /images/get`
2574 2574
... ... 
@@ -2592,7 +2593,7 @@ See the [image tarball format](#image-tarball-format) for more details.
2592 2592
2593 2593 
     Binary data stream
2594 2594
2595 
-Status Codes:
2595 
+**Status codes**:
2596 2596
2597 2597 
 -   **200** – no error
2598 2598 
 -   **500** – server error
... ... 
@@ -2614,7 +2615,7 @@ See the [image tarball format](#image-tarball-format) for more details.
2614 2614
2615 2615 
     HTTP/1.1 200 OK
2616 2616
2617 
-Status Codes:
2617 
+**Status codes**:
2618 2618
2619 2619 
 -   **200** – no error
2620 2620 
 -   **500** – server error
... ... 
@@ -2672,7 +2673,7 @@ Sets up an exec instance in a running container `id`
2672 2672 
          "Warnings":[]
2673 2673 
     }
2674 2674
2675 
-Json Parameters:
2675 
+**JSON parameters**:
2676 2676
2677 2677 
 -   **AttachStdin** - Boolean value, attaches to `stdin` of the `exec` command.
2678 2678 
 -   **AttachStdout** - Boolean value, attaches to `stdout` of the `exec` command.
... ... 
@@ -2684,7 +2685,7 @@ Json Parameters:
2684 2684 
 -   **Cmd** - Command to run specified as a string or an array of strings.
2685 2685
2686 2686
2687 
-Status Codes:
2687 
+**Status codes**:
2688 2688
2689 2689 
 -   **201** – no error
2690 2690 
 -   **404** – no such container
... ... 
@@ -2716,12 +2717,12 @@ interactive session with the `exec` command.
2716 2716
2717 2717 
     {{ STREAM }}
2718 2718
2719 
-Json Parameters:
2719 
+**JSON parameters**:
2720 2720
2721 2721 
 -   **Detach** - Detach from the `exec` command.
2722 2722 
 -   **Tty** - Boolean value to allocate a pseudo-TTY.
2723 2723
2724 
-Status Codes:
2724 
+**Status codes**:
2725 2725
2726 2726 
 -   **200** – no error
2727 2727 
 -   **404** – no such exec instance
... ... 
@@ -2747,12 +2748,12 @@ This API is valid only if `tty` was specified as part of creating and starting t
2747 2747 
     HTTP/1.1 201 Created
2748 2748 
     Content-Type: text/plain
2749 2749
2750 
-Query Parameters:
2750 
+**Query parameters**:
2751 2751
2752 2752 
 -   **h** – height of `tty` session
2753 2753 
 -   **w** – width
2754 2754
2755 
-Status Codes:
2755 
+**Status codes**:
2756 2756
2757 2757 
 -   **201** – no error
2758 2758 
 -   **404** – no such exec instance
... ... 
@@ -2794,7 +2795,7 @@ Return low-level information about the `exec` command `id`.
2794 2794 
         "Running": false
2795 2795 
     }
2796 2796
2797 
-Status Codes:
2797 
+**Status codes**:
2798 2798
2799 2799 
 -   **200** – no error
2800 2800 
 -   **404** – no such exec instance
... ... 
@@ -2826,11 +2827,11 @@ Status Codes:
2826 2826 
       "Warnings": []
2827 2827 
     }
2828 2828
2829 
-Query Parameters:
2829 
+**Query parameters**:
2830 2830
2831 2831 
 - **filters** - JSON encoded value of the filters (a `map[string][]string`) to process on the volumes list. There is one available filter: `dangling=true`
2832 2832
2833 
-Status Codes:
2833 
+**Status codes**:
2834 2834
2835 2835 
 -   **200** - no error
2836 2836 
 -   **500** - server error
... ... 
@@ -2861,12 +2862,12 @@ Create a volume
2861 2861 
       "Mountpoint": "/var/lib/docker/volumes/tardis"
2862 2862 
     }
2863 2863
2864 
-Status Codes:
2864 
+**Status codes**:
2865 2865
2866 2866 
 - **201** - no error
2867 2867 
 - **500**  - server error
2868 2868
2869 
-JSON Parameters:
2869 
+**JSON parameters**:
2870 2870
2871 2871 
 - **Name** - The new volume's name. If not specified, Docker generates a name.
2872 2872 
 - **Driver** - Name of the volume driver to use. Defaults to `local` for the name.
... ... 
@@ -2894,7 +2895,7 @@ Return low-level information on the volume `name`
2894 2894 
       "Mountpoint": "/var/lib/docker/volumes/tardis"
2895 2895 
     }
2896 2896
2897 
-Status Codes:
2897 
+**Status codes**:
2898 2898
2899 2899 
 -   **200** - no error
2900 2900 
 -   **404** - no such volume
... ... 
@@ -2914,7 +2915,7 @@ Instruct the driver to remove the volume (`name`).
2914 2914
2915 2915 
     HTTP/1.1 204 No Content
2916 2916
2917 
-Status Codes
2917 
+**Status codes**:
2918 2918
2919 2919 
 -   **204** - no error
2920 2920 
 -   **404** - no such volume or volume driver
... ... 
@@ -2995,14 +2996,14 @@ Content-Type: application/json
2995 2995 
 ]
2996 2996 
 ```
2997 2997
2998 
-Query Parameters:
2998 
+**Query parameters**:
2999 2999
3000 3000 
 - **filters** - JSON encoded network list filter. The filter value is one of:
3001 
-  -   `name=<network-name>` Matches all or part of a network name.
3002 3001 
   -   `id=<network-id>` Matches all or part of a network id.
3002 
+  -   `name=<network-name>` Matches all or part of a network name.
3003 3003 
   -   `type=["custom"|"builtin"]` Filters networks by type. The `custom` keyword returns all user-defined networks.
3004 3004
3005 
-Status Codes:
3005 
+**Status codes**:
3006 3006
3007 3007 
 -   **200** - no error
3008 3008 
 -   **500** - server error
... ... 
@@ -3058,7 +3059,7 @@ Content-Type: application/json
3058 3058 
 }
3059 3059 
 ```
3060 3060
3061 
-Status Codes:
3061 
+**Status codes**:
3062 3062
3063 3063 
 -   **200** - no error
3064 3064 
 -   **404** - network not found
... ... 
@@ -3110,13 +3111,13 @@ Content-Type: application/json
3110 3110 
 }
3111 3111 
 ```
3112 3112
3113 
-Status Codes:
3113 
+**Status codes**:
3114 3114
3115 3115 
 - **201** - no error
3116 3116 
 - **404** - plugin not found
3117 3117 
 - **500** - server error
3118 3118
3119 
-JSON Parameters:
3119 
+**JSON parameters**:
3120 3120
3121 3121 
 - **Name** - The new network's name. this is a mandatory field
3122 3122 
 - **Driver** - Name of the network driver plugin to use. Defaults to `bridge` driver
... ... 
@@ -3151,13 +3152,13 @@ Content-Type: application/json
3151 3151
3152 3152 
     HTTP/1.1 200 OK
3153 3153
3154 
-Status Codes:
3154 
+**Status codes**:
3155 3155
3156 3156 
 - **200** - no error
3157 3157 
 - **404** - network or container is not found
3158 3158 
 - **500** - Internal Server Error
3159 3159
3160 
-JSON Parameters:
3160 
+**JSON parameters**:
3161 3161
3162 3162 
 - **container** - container-id/name to be connected to the network
3163 3163
... ... 
@@ -3183,13 +3184,13 @@ Content-Type: application/json
3183 3183
3184 3184 
     HTTP/1.1 200 OK
3185 3185
3186 
-Status Codes:
3186 
+**Status codes**:
3187 3187
3188 3188 
 - **200** - no error
3189 3189 
 - **404** - network or container not found
3190 3190 
 - **500** - Internal Server Error
3191 3191
3192 
-JSON Parameters:
3192 
+**JSON parameters**:
3193 3193
3194 3194 
 - **Container** - container-id/name to be disconnected from a network
3195 3195 
 - **Force** - Force the container to disconnect from a network
... ... 
@@ -3208,7 +3209,7 @@ Instruct the driver to remove the network (`id`).
3208 3208
3209 3209 
     HTTP/1.1 200 OK
3210 3210
3211 
-Status Codes
3211 
+**Status codes**:
3212 3212
3213 3213 
 -   **200** - no error
3214 3214 
 -   **404** - no such network
docs/reference/api/docker_remote_api_v1.23.md
History View file @ 0194094
... ... 
@@ -202,7 +202,7 @@ List containers
202 202 
          }
203 203 
     ]
204 204
205 
-Query Parameters:
205 
+**Query parameters**:
206 206
207 207 
 -   **all** – 1/True/true or 0/False/false, Show all containers.
208 208 
         Only running containers are shown by default (i.e., this defaults to false)
... ... 
@@ -224,7 +224,7 @@ Query Parameters:
224 224 
   -   `since`=(`<container id>` or `<container name>`)
225 225 
   -   `volume`=(`<volume name>` or `<mount point destination>`)
226 226
227 
-Status Codes:
227 
+**Status codes**:
228 228
229 229 
 -   **200** – no error
230 230 
 -   **400** – bad parameter
... ... 
@@ -344,7 +344,7 @@ Create a container
344 344 
            "Warnings":[]
345 345 
       }
346 346
347 
-Json Parameters:
347 
+**JSON parameters**:
348 348
349 349 
 -   **Hostname** - A string value containing the hostname to use for the
350 350 
       container.
... ... 
@@ -458,12 +458,12 @@ Json Parameters:
458 458 
     -   **VolumeDriver** - Driver that this container users to mount volumes.
459 459 
     -   **ShmSize** - Size of `/dev/shm` in bytes. The size must be greater than 0.  If omitted the system uses 64MB.
460 460
461 
-Query Parameters:
461 
+**Query parameters**:
462 462
463 463 
 -   **name** – Assign the specified name to the container. Must
464 464 
     match `/?[a-zA-Z0-9_-]+`.
465 465
466 
-Status Codes:
466 
+**Status codes**:
467 467
468 468 
 -   **201** – no error
469 469 
 -   **400** – bad parameter
... ... 
@@ -478,7 +478,6 @@ Status Codes:
478 478
479 479 
 Return low-level information on the container `id`
480 480
481 
-
482 481 
 **Example request**:
483 482
484 483 
       GET /containers/4fa6e0f0c678/json HTTP/1.1
... ... 
@@ -666,11 +665,11 @@ Return low-level information on the container `id`
666 666 
     ....
667 667 
     }
668 668
669 
-Query Parameters:
669 
+**Query parameters**:
670 670
671 671 
 -   **size** – 1/True/true or 0/False/false, return container size information. Default is `false`.
672 672
673 
-Status Codes:
673 
+**Status codes**:
674 674
675 675 
 -   **200** – no error
676 676 
 -   **404** – no such container
... ... 
@@ -730,11 +729,11 @@ supported on Windows.
730 730 
       ],
731 731 
     }
732 732
733 
-Query Parameters:
733 
+**Query parameters**:
734 734
735 735 
 -   **ps_args** – `ps` arguments to use (e.g., `aux`), defaults to `-ef`
736 736
737 
-Status Codes:
737 
+**Status codes**:
738 738
739 739 
 -   **200** – no error
740 740 
 -   **404** – no such container
... ... 
@@ -762,7 +761,7 @@ Get `stdout` and `stderr` logs from the container ``id``
762 762
763 763 
      {{ STREAM }}
764 764
765 
-Query Parameters:
765 
+**Query parameters**:
766 766
767 767 
 -   **follow** – 1/True/true or 0/False/false, return stream. Default `false`.
768 768 
 -   **stdout** – 1/True/true or 0/False/false, show `stdout` log. Default `false`.
... ... 
@@ -773,7 +772,7 @@ Query Parameters:
773 773 
         every log line. Default `false`.
774 774 
 -   **tail** – Output specified number of lines at the end of logs: `all` or `<number>`. Default all.
775 775
776 
-Status Codes:
776 
+**Status codes**:
777 777
778 778 
 -   **101** – no error, hints proxy about hijacking
779 779 
 -   **200** – no error, no upgrade header found
... ... 
@@ -816,7 +815,7 @@ Values for `Kind`:
816 816 
 - `1`: Add
817 817 
 - `2`: Delete
818 818
819 
-Status Codes:
819 
+**Status codes**:
820 820
821 821 
 -   **200** – no error
822 822 
 -   **404** – no such container
... ... 
@@ -839,7 +838,7 @@ Export the contents of container `id`
839 839
840 840 
     {{ TAR STREAM }}
841 841
842 
-Status Codes:
842 
+**Status codes**:
843 843
844 844 
 -   **200** – no error
845 845 
 -   **404** – no such container
... ... 
@@ -959,11 +958,11 @@ This endpoint returns a live stream of a container's resource usage statistics.
959 959
960 960 
 The precpu_stats is the cpu statistic of last read, which is used for calculating the cpu usage percent. It is not the exact copy of the “cpu_stats” field.
961 961
962 
-Query Parameters:
962 
+**Query parameters**:
963 963
964 964 
 -   **stream** – 1/True/true or 0/False/false, pull stats once then disconnect. Default `true`.
965 965
966 
-Status Codes:
966 
+**Status codes**:
967 967
968 968 
 -   **200** – no error
969 969 
 -   **404** – no such container
... ... 
@@ -985,12 +984,12 @@ Resize the TTY for container with  `id`. The unit is number of characters. You m
985 985 
       Content-Length: 0
986 986 
       Content-Type: text/plain; charset=utf-8
987 987
988 
-Query Parameters:
988 
+**Query parameters**:
989 989
990 990 
 -   **h** – height of `tty` session
991 991 
 -   **w** – width
992 992
993 
-Status Codes:
993 
+**Status codes**:
994 994
995 995 
 -   **200** – no error
996 996 
 -   **404** – No such container
... ... 
@@ -1014,13 +1013,13 @@ Start the container `id`
1014 1014
1015 1015 
     HTTP/1.1 204 No Content
1016 1016
1017 
-Query Parameters:
1017 
+**Query parameters**:
1018 1018
1019 1019 
 -   **detachKeys** – Override the key sequence for detaching a
1020 1020 
         container. Format is a single character `[a-Z]` or `ctrl-<value>`
1021 1021 
         where `<value>` is one of: `a-z`, `@`, `^`, `[`, `,` or `_`.
1022 1022
1023 
-Status Codes:
1023 
+**Status codes**:
1024 1024
1025 1025 
 -   **204** – no error
1026 1026 
 -   **304** – container already started
... ... 
@@ -1041,11 +1040,11 @@ Stop the container `id`
1041 1041
1042 1042 
     HTTP/1.1 204 No Content
1043 1043
1044 
-Query Parameters:
1044 
+**Query parameters**:
1045 1045
1046 1046 
 -   **t** – number of seconds to wait before killing the container
1047 1047
1048 
-Status Codes:
1048 
+**Status codes**:
1049 1049
1050 1050 
 -   **204** – no error
1051 1051 
 -   **304** – container already stopped
... ... 
@@ -1066,11 +1065,11 @@ Restart the container `id`
1066 1066
1067 1067 
     HTTP/1.1 204 No Content
1068 1068
1069 
-Query Parameters:
1069 
+**Query parameters**:
1070 1070
1071 1071 
 -   **t** – number of seconds to wait before killing the container
1072 1072
1073 
-Status Codes:
1073 
+**Status codes**:
1074 1074
1075 1075 
 -   **204** – no error
1076 1076 
 -   **404** – no such container
... ... 
@@ -1090,12 +1089,12 @@ Kill the container `id`
1090 1090
1091 1091 
     HTTP/1.1 204 No Content
1092 1092
1093 
-Query Parameters
1093 
+**Query parameters**:
1094 1094
1095 1095 
 -   **signal** - Signal to send to the container: integer or string like `SIGINT`.
1096 1096 
         When not set, `SIGKILL` is assumed and the call waits for the container to exit.
1097 1097
1098 
-Status Codes:
1098 
+**Status codes**:
1099 1099
1100 1100 
 -   **204** – no error
1101 1101 
 -   **404** – no such container
... ... 
@@ -1138,7 +1137,7 @@ Update configuration of one or more containers.
1138 1138 
            "Warnings": []
1139 1139 
        }
1140 1140
1141 
-Status Codes:
1141 
+**Status codes**:
1142 1142
1143 1143 
 -   **200** – no error
1144 1144 
 -   **400** – bad parameter
... ... 
@@ -1159,11 +1158,11 @@ Rename the container `id` to a `new_name`
1159 1159
1160 1160 
     HTTP/1.1 204 No Content
1161 1161
1162 
-Query Parameters:
1162 
+**Query parameters**:
1163 1163
1164 1164 
 -   **name** – new name for the container
1165 1165
1166 
-Status Codes:
1166 
+**Status codes**:
1167 1167
1168 1168 
 -   **204** – no error
1169 1169 
 -   **404** – no such container
... ... 
@@ -1184,7 +1183,7 @@ Pause the container `id`
1184 1184
1185 1185 
     HTTP/1.1 204 No Content
1186 1186
1187 
-Status Codes:
1187 
+**Status codes**:
1188 1188
1189 1189 
 -   **204** – no error
1190 1190 
 -   **404** – no such container
... ... 
@@ -1204,7 +1203,7 @@ Unpause the container `id`
1204 1204
1205 1205 
     HTTP/1.1 204 No Content
1206 1206
1207 
-Status Codes:
1207 
+**Status codes**:
1208 1208
1209 1209 
 -   **204** – no error
1210 1210 
 -   **404** – no such container
... ... 
@@ -1229,7 +1228,7 @@ Attach to the container `id`
1229 1229
1230 1230 
     {{ STREAM }}
1231 1231
1232 
-Query Parameters:
1232 
+**Query parameters**:
1233 1233
1234 1234 
 -   **detachKeys** – Override the key sequence for detaching a
1235 1235 
         container. Format is a single character `[a-Z]` or `ctrl-<value>`
... ... 
@@ -1244,7 +1243,7 @@ Query Parameters:
1244 1244 
 -   **stderr** – 1/True/true or 0/False/false, if `logs=true`, return
1245 1245 
         `stderr` log, if `stream=true`, attach to `stderr`. Default `false`.
1246 1246
1247 
-Status Codes:
1247 
+**Status codes**:
1248 1248
1249 1249 
 -   **101** – no error, hints proxy about hijacking
1250 1250 
 -   **200** – no error, no upgrade header found
... ... 
@@ -1313,7 +1312,7 @@ Implements websocket protocol handshake according to [RFC 6455](http://tools.iet
1313 1313
1314 1314 
     {{ STREAM }}
1315 1315
1316 
-Query Parameters:
1316 
+**Query parameters**:
1317 1317
1318 1318 
 -   **detachKeys** – Override the key sequence for detaching a
1319 1319 
         container. Format is a single character `[a-Z]` or `ctrl-<value>`
... ... 
@@ -1328,7 +1327,7 @@ Query Parameters:
1328 1328 
 -   **stderr** – 1/True/true or 0/False/false, if `logs=true`, return
1329 1329 
         `stderr` log, if `stream=true`, attach to `stderr`. Default `false`.
1330 1330
1331 
-Status Codes:
1331 
+**Status codes**:
1332 1332
1333 1333 
 -   **200** – no error
1334 1334 
 -   **400** – bad parameter
... ... 
@@ -1352,7 +1351,7 @@ Block until container `id` stops, then returns the exit code
1352 1352
1353 1353 
     {"StatusCode": 0}
1354 1354
1355 
-Status Codes:
1355 
+**Status codes**:
1356 1356
1357 1357 
 -   **200** – no error
1358 1358 
 -   **404** – no such container
... ... 
@@ -1372,14 +1371,14 @@ Remove the container `id` from the filesystem
1372 1372
1373 1373 
     HTTP/1.1 204 No Content
1374 1374
1375 
-Query Parameters:
1375 
+**Query parameters**:
1376 1376
1377 1377 
 -   **v** – 1/True/true or 0/False/false, Remove the volumes
1378 1378 
         associated to the container. Default `false`.
1379 1379 
 -   **force** - 1/True/true or 0/False/false, Kill then remove the container.
1380 1380 
         Default `false`.
1381 1381
1382 
-Status Codes:
1382 
+**Status codes**:
1383 1383
1384 1384 
 -   **204** – no error
1385 1385 
 -   **400** – bad parameter
... ... 
@@ -1411,7 +1410,7 @@ Copy files or folders of container `id`
1411 1411
1412 1412 
     {{ TAR STREAM }}
1413 1413
1414 
-Status Codes:
1414 
+**Status codes**:
1415 1415
1416 1416 
 -   **200** – no error
1417 1417 
 -   **404** – no such container
... ... 
@@ -1430,7 +1429,7 @@ following section.
1430 1430
1431 1431 
 Get a tar archive of a resource in the filesystem of container `id`.
1432 1432
1433 
-Query Parameters:
1433 
+**Query parameters**:
1434 1434
1435 1435 
 - **path** - resource in the container's filesystem to archive. Required.
1436 1436
... ... 
@@ -1441,39 +1440,41 @@ Query Parameters:
1441 1441 
     indicates that only the contents of the **path** directory should be
1442 1442 
     copied. A symlink is always resolved to its target.
1443 1443
1444 
-    **Note**: It is not possible to copy certain system files such as resources
1445 
-    under `/proc`, `/sys`, `/dev`, and mounts created by the user in the
1446 
-    container.
1444 
+    > **Note**: It is not possible to copy certain system files such as resources
1445 
+    > under `/proc`, `/sys`, `/dev`, and mounts created by the user in the
1446 
+    > container.
1447 1447
1448 1448 
 **Example request**:
1449 1449
1450 
-        GET /containers/8cce319429b2/archive?path=/root HTTP/1.1
1450 
+    GET /containers/8cce319429b2/archive?path=/root HTTP/1.1
1451 1451
1452 1452 
 **Example response**:
1453 1453
1454 
-        HTTP/1.1 200 OK
1455 
-        Content-Type: application/x-tar
1456 
-        X-Docker-Container-Path-Stat: eyJuYW1lIjoicm9vdCIsInNpemUiOjQwOTYsIm1vZGUiOjIxNDc0ODQwOTYsIm10aW1lIjoiMjAxNC0wMi0yN1QyMDo1MToyM1oiLCJsaW5rVGFyZ2V0IjoiIn0=
1454 
+    HTTP/1.1 200 OK
1455 
+    Content-Type: application/x-tar
1456 
+    X-Docker-Container-Path-Stat: eyJuYW1lIjoicm9vdCIsInNpemUiOjQwOTYsIm1vZGUiOjIxNDc0ODQwOTYsIm10aW1lIjoiMjAxNC0wMi0yN1QyMDo1MToyM1oiLCJsaW5rVGFyZ2V0IjoiIn0=
1457 1457
1458 
-        {{ TAR STREAM }}
1458 
+    {{ TAR STREAM }}
1459 1459
1460 1460 
 On success, a response header `X-Docker-Container-Path-Stat` will be set to a
1461 1461 
 base64-encoded JSON object containing some filesystem header information about
1462 1462 
 the archived resource. The above example value would decode to the following
1463 1463 
 JSON object (whitespace added for readability):
1464 1464
1465 
-        {
1466 
-            "name": "root",
1467 
-            "size": 4096,
1468 
-            "mode": 2147484096,
1469 
-            "mtime": "2014-02-27T20:51:23Z",
1470 
-            "linkTarget": ""
1471 
-        }
1465 
+```json
1466 
+{
1467 
+    "name": "root",
1468 
+    "size": 4096,
1469 
+    "mode": 2147484096,
1470 
+    "mtime": "2014-02-27T20:51:23Z",
1471 
+    "linkTarget": ""
1472 
+}
1473 
+```
1472 1474
1473 1475 
 A `HEAD` request can also be made to this endpoint if only this information is
1474 1476 
 desired.
1475 1477
1476 
-Status Codes:
1478 
+**Status codes**:
1477 1479
1478 1480 
 - **200** - success, returns archive of copied resource
1479 1481 
 - **400** - client error, bad parameter, details in JSON response body, one of:
... ... 
@@ -1492,7 +1493,7 @@ Status Codes:
1492 1492 
 Upload a tar archive to be extracted to a path in the filesystem of container
1493 1493 
 `id`.
1494 1494
1495 
-Query Parameters:
1495 
+**Query parameters**:
1496 1496
1497 1497 
 - **path** - path to a directory in the container
1498 1498 
     to extract the archive's contents into. Required.
... ... 
@@ -1514,7 +1515,7 @@ Query Parameters:
1514 1514
1515 1515 
     HTTP/1.1 200 OK
1516 1516
1517 
-Status Codes:
1517 
+**Status codes**:
1518 1518
1519 1519 
 - **200** – the content was extracted successfully
1520 1520 
 - **400** - client error, bad parameter, details in JSON response body, one of:
... ... 
@@ -1616,7 +1617,7 @@ digest. You can reference this digest using the value:
1616 1616 
 See the `docker run` and `docker build` commands for examples of digest and tag
1617 1617 
 references on the command line.
1618 1618
1619 
-Query Parameters:
1619 
+**Query parameters**:
1620 1620
1621 1621 
 -   **all** – 1/True/true or 0/False/false, default false
1622 1622 
 -   **filters** – a JSON encoded value of the filters (a map[string][]string) to process on the images list. Available filters:
... ... 
@@ -1660,7 +1661,7 @@ command*](../../reference/builder.md#add)).
1660 1660 
 The build is canceled if the client drops the connection by quitting
1661 1661 
 or being killed.
1662 1662
1663 
-Query Parameters:
1663 
+**Query parameters**:
1664 1664
1665 1665 
 -   **dockerfile** - Path within the build context to the Dockerfile. This is
1666 1666 
         ignored if `remote` is specified and points to an individual filename.
... ... 
@@ -1715,7 +1716,7 @@ Query Parameters:
1715 1715 
     be specified with both a "https://" prefix and a "/v1/" suffix even
1716 1716 
     though Docker will prefer to use the v2 registry API.
1717 1717
1718 
-Status Codes:
1718 
+**Status codes**:
1719 1719
1720 1720 
 -   **200** – no error
1721 1721 
 -   **500** – server error
... ... 
@@ -1744,7 +1745,7 @@ When using this endpoint to pull an image from the registry, the
1744 1744 
 `X-Registry-Auth` header can be used to include
1745 1745 
 a base64-encoded AuthConfig object.
1746 1746
1747 
-Query Parameters:
1747 
+**Query parameters**:
1748 1748
1749 1749 
 -   **fromImage** – Name of the image to pull. The name may include a tag or
1750 1750 
         digest. This parameter may only be used when pulling an image.
... ... 
@@ -1778,7 +1779,7 @@ Query Parameters:
1778 1778 
     }
1779 1779 
         ```
1780 1780
1781 
-Status Codes:
1781 
+**Status codes**:
1782 1782
1783 1783 
 -   **200** – no error
1784 1784 
 -   **500** – server error
... ... 
@@ -1897,7 +1898,7 @@ Return low-level information on the image `name`
1897 1897 
        }
1898 1898 
     }
1899 1899
1900 
-Status Codes:
1900 
+**Status codes**:
1901 1901
1902 1902 
 -   **200** – no error
1903 1903 
 -   **404** – no such image
... ... 
@@ -1951,7 +1952,7 @@ Return the history of the image `name`
1951 1951 
         }
1952 1952 
     ]
1953 1953
1954 
-Status Codes:
1954 
+**Status codes**:
1955 1955
1956 1956 
 -   **200** – no error
1957 1957 
 -   **404** – no such image
... ... 
@@ -1988,7 +1989,7 @@ The push is cancelled if the HTTP connection is closed.
1988 1988 
     POST /images/registry.acme.com:5000/test/push HTTP/1.1
1989 1989
1990 1990
1991 
-Query Parameters:
1991 
+**Query parameters**:
1992 1992
1993 1993 
 -   **tag** – The tag to associate with the image on the registry. This is optional.
1994 1994
... ... 
@@ -2013,7 +2014,7 @@ Request Headers:
2013 2013 
     }
2014 2014 
         ```
2015 2015
2016 
-Status Codes:
2016 
+**Status codes**:
2017 2017
2018 2018 
 -   **200** – no error
2019 2019 
 -   **404** – no such image
... ... 
@@ -2033,13 +2034,13 @@ Tag the image `name` into a repository
2033 2033
2034 2034 
     HTTP/1.1 201 Created
2035 2035
2036 
-Query Parameters:
2036 
+**Query parameters**:
2037 2037
2038 2038 
 -   **repo** – The repository to tag in
2039 2039 
 -   **force** – 1/True/true or 0/False/false, default false
2040 2040 
 -   **tag** - The new tag name
2041 2041
2042 
-Status Codes:
2042 
+**Status codes**:
2043 2043
2044 2044 
 -   **201** – no error
2045 2045 
 -   **400** – bad parameter
... ... 
@@ -2068,12 +2069,12 @@ Remove the image `name` from the filesystem
2068 2068 
      {"Deleted": "53b4f83ac9"}
2069 2069 
     ]
2070 2070
2071 
-Query Parameters:
2071 
+**Query parameters**:
2072 2072
2073 2073 
 -   **force** – 1/True/true or 0/False/false, default false
2074 2074 
 -   **noprune** – 1/True/true or 0/False/false, default false
2075 2075
2076 
-Status Codes:
2076 
+**Status codes**:
2077 2077
2078 2078 
 -   **200** – no error
2079 2079 
 -   **404** – no such image
... ... 
@@ -2124,11 +2125,11 @@ Search for an image on [Docker Hub](https://hub.docker.com).
2124 2124 
     ...
2125 2125 
     ]
2126 2126
2127 
-Query Parameters:
2127 
+**Query parameters**:
2128 2128
2129 2129 
 -   **term** – term to search
2130 2130
2131 
-Status Codes:
2131 
+**Status codes**:
2132 2132
2133 2133 
 -   **200** – no error
2134 2134 
 -   **500** – server error
... ... 
@@ -2162,7 +2163,7 @@ if available, for accessing the registry without password.
2162 2162 
          "IdentityToken": "9cbaf023786cd7..."
2163 2163 
     }
2164 2164
2165 
-Status Codes:
2165 
+**Status codes**:
2166 2166
2167 2167 
 -   **200** – no error
2168 2168 
 -   **204** – no error
... ... 
@@ -2252,7 +2253,7 @@ Display system-wide information
2252 2252 
         "SystemTime": "2015-03-10T11:11:23.730591467-07:00"
2253 2253 
     }
2254 2254
2255 
-Status Codes:
2255 
+**Status codes**:
2256 2256
2257 2257 
 -   **200** – no error
2258 2258 
 -   **500** – server error
... ... 
@@ -2284,7 +2285,7 @@ Show the docker version information
2284 2284 
          "Experimental": true
2285 2285 
     }
2286 2286
2287 
-Status Codes:
2287 
+**Status codes**:
2288 2288
2289 2289 
 -   **200** – no error
2290 2290 
 -   **500** – server error
... ... 
@@ -2306,7 +2307,7 @@ Ping the docker server
2306 2306
2307 2307 
     OK
2308 2308
2309 
-Status Codes:
2309 
+**Status codes**:
2310 2310
2311 2311 
 -   **200** - no error
2312 2312 
 -   **500** - server error
... ... 
@@ -2362,11 +2363,11 @@ Create a new image from a container's changes
2362 2362
2363 2363 
     {"Id": "596069db4bf5"}
2364 2364
2365 
-Json Parameters:
2365 
+**JSON parameters**:
2366 2366
2367 2367 
 -  **config** - the container's configuration
2368 2368
2369 
-Query Parameters:
2369 
+**Query parameters**:
2370 2370
2371 2371 
 -   **container** – source container
2372 2372 
 -   **repo** – repository
... ... 
@@ -2377,7 +2378,7 @@ Query Parameters:
2377 2377 
 -   **pause** – 1/True/true or 0/False/false, whether to pause the container before committing
2378 2378 
 -   **changes** – Dockerfile instructions to apply while committing
2379 2379
2380 
-Status Codes:
2380 
+**Status codes**:
2381 2381
2382 2382 
 -   **201** – no error
2383 2383 
 -   **404** – no such container
... ... 
@@ -2565,8 +2566,7 @@ Docker networks report the following events:
2565 2565 
       "timeNano": 1461943105338056026
2566 2566 
     }
2567 2567
2568 
-
2569 
-Query Parameters:
2568 
+**Query parameters**:
2570 2569
2571 2570 
 -   **since** – Timestamp used for polling
2572 2571 
 -   **until** – Timestamp used for polling
... ... 
@@ -2579,7 +2579,7 @@ Query Parameters:
2579 2579 
   -   `volume=<string>`; -- volume to filter
2580 2580 
   -   `network=<string>`; -- network to filter
2581 2581
2582 
-Status Codes:
2582 
+**Status codes**:
2583 2583
2584 2584 
 -   **200** – no error
2585 2585 
 -   **500** – server error
... ... 
@@ -2609,12 +2609,12 @@ See the [image tarball format](#image-tarball-format) for more details.
2609 2609
2610 2610 
     Binary data stream
2611 2611
2612 
-Status Codes:
2612 
+**Status codes**:
2613 2613
2614 2614 
 -   **200** – no error
2615 2615 
 -   **500** – server error
2616 2616
2617 
-### Get a tarball containing all images.
2617 
+### Get a tarball containing all images
2618 2618
2619 2619 
 `GET /images/get`
2620 2620
... ... 
@@ -2638,7 +2638,7 @@ See the [image tarball format](#image-tarball-format) for more details.
2638 2638
2639 2639 
     Binary data stream
2640 2640
2641 
-Status Codes:
2641 
+**Status codes**:
2642 2642
2643 2643 
 -   **200** – no error
2644 2644 
 -   **500** – server error
... ... 
@@ -2660,7 +2660,7 @@ See the [image tarball format](#image-tarball-format) for more details.
2660 2660
2661 2661 
     HTTP/1.1 200 OK
2662 2662
2663 
-Status Codes:
2663 
+**Status codes**:
2664 2664
2665 2665 
 -   **200** – no error
2666 2666 
 -   **500** – server error
... ... 
@@ -2718,7 +2718,7 @@ Sets up an exec instance in a running container `id`
2718 2718 
          "Warnings":[]
2719 2719 
     }
2720 2720
2721 
-Json Parameters:
2721 
+**JSON parameters**:
2722 2722
2723 2723 
 -   **AttachStdin** - Boolean value, attaches to `stdin` of the `exec` command.
2724 2724 
 -   **AttachStdout** - Boolean value, attaches to `stdout` of the `exec` command.
... ... 
@@ -2730,7 +2730,7 @@ Json Parameters:
2730 2730 
 -   **Cmd** - Command to run specified as a string or an array of strings.
2731 2731
2732 2732
2733 
-Status Codes:
2733 
+**Status codes**:
2734 2734
2735 2735 
 -   **201** – no error
2736 2736 
 -   **404** – no such container
... ... 
@@ -2762,12 +2762,12 @@ interactive session with the `exec` command.
2762 2762
2763 2763 
     {{ STREAM }}
2764 2764
2765 
-Json Parameters:
2765 
+**JSON parameters**:
2766 2766
2767 2767 
 -   **Detach** - Detach from the `exec` command.
2768 2768 
 -   **Tty** - Boolean value to allocate a pseudo-TTY.
2769 2769
2770 
-Status Codes:
2770 
+**Status codes**:
2771 2771
2772 2772 
 -   **200** – no error
2773 2773 
 -   **404** – no such exec instance
... ... 
@@ -2793,12 +2793,12 @@ This API is valid only if `tty` was specified as part of creating and starting t
2793 2793 
     HTTP/1.1 201 Created
2794 2794 
     Content-Type: text/plain
2795 2795
2796 
-Query Parameters:
2796 
+**Query parameters**:
2797 2797
2798 2798 
 -   **h** – height of `tty` session
2799 2799 
 -   **w** – width
2800 2800
2801 
-Status Codes:
2801 
+**Status codes**:
2802 2802
2803 2803 
 -   **201** – no error
2804 2804 
 -   **404** – no such exec instance
... ... 
@@ -2840,7 +2840,7 @@ Return low-level information about the `exec` command `id`.
2840 2840 
         "Running": false
2841 2841 
     }
2842 2842
2843 
-Status Codes:
2843 
+**Status codes**:
2844 2844
2845 2845 
 -   **200** – no error
2846 2846 
 -   **404** – no such exec instance
... ... 
@@ -2872,11 +2872,11 @@ Status Codes:
2872 2872 
       "Warnings": []
2873 2873 
     }
2874 2874
2875 
-Query Parameters:
2875 
+**Query parameters**:
2876 2876
2877 2877 
 - **filters** - JSON encoded value of the filters (a `map[string][]string`) to process on the volumes list. There is one available filter: `dangling=true`
2878 2878
2879 
-Status Codes:
2879 
+**Status codes**:
2880 2880
2881 2881 
 -   **200** - no error
2882 2882 
 -   **500** - server error
... ... 
@@ -2915,12 +2915,12 @@ Create a volume
2915 2915 
       },
2916 2916 
     }
2917 2917
2918 
-Status Codes:
2918 
+**Status codes**:
2919 2919
2920 2920 
 - **201** - no error
2921 2921 
 - **500**  - server error
2922 2922
2923 
-JSON Parameters:
2923 
+**JSON parameters**:
2924 2924
2925 2925 
 - **Name** - The new volume's name. If not specified, Docker generates a name.
2926 2926 
 - **Driver** - Name of the volume driver to use. Defaults to `local` for the name.
... ... 
@@ -2953,7 +2953,7 @@ Return low-level information on the volume `name`
2953 2953 
         }
2954 2954 
     }
2955 2955
2956 
-Status Codes:
2956 
+**Status codes**:
2957 2957
2958 2958 
 -   **200** - no error
2959 2959 
 -   **404** - no such volume
... ... 
@@ -2973,14 +2973,14 @@ Instruct the driver to remove the volume (`name`).
2973 2973
2974 2974 
     HTTP/1.1 204 No Content
2975 2975
2976 
-Status Codes
2976 
+**Status codes**:
2977 2977
2978 2978 
 -   **204** - no error
2979 2979 
 -   **404** - no such volume or volume driver
2980 2980 
 -   **409** - volume is in use and cannot be removed
2981 2981 
 -   **500** - server error
2982 2982
2983 
-## 2.5 Networks
2983 
+## 3.5 Networks
2984 2984
2985 2985 
 ### List networks
2986 2986
... ... 
@@ -3060,14 +3060,14 @@ Content-Type: application/json
3060 3060 
 ]
3061 3061 
 ```
3062 3062
3063 
-Query Parameters:
3063 
+**Query parameters**:
3064 3064
3065 3065 
 - **filters** - JSON encoded network list filter. The filter value is one of:
3066 
-  -   `name=<network-name>` Matches all or part of a network name.
3067 3066 
   -   `id=<network-id>` Matches all or part of a network id.
3067 
+  -   `name=<network-name>` Matches all or part of a network name.
3068 3068 
   -   `type=["custom"|"builtin"]` Filters networks by type. The `custom` keyword returns all user-defined networks.
3069 3069
3070 
-Status Codes:
3070 
+**Status codes**:
3071 3071
3072 3072 
 -   **200** - no error
3073 3073 
 -   **500** - server error
... ... 
@@ -3129,7 +3129,7 @@ Content-Type: application/json
3129 3129 
 }
3130 3130 
 ```
3131 3131
3132 
-Status Codes:
3132 
+**Status codes**:
3133 3133
3134 3134 
 -   **200** - no error
3135 3135 
 -   **404** - network not found
... ... 
@@ -3195,13 +3195,13 @@ Content-Type: application/json
3195 3195 
 }
3196 3196 
 ```
3197 3197
3198 
-Status Codes:
3198 
+**Status codes**:
3199 3199
3200 3200 
 - **201** - no error
3201 3201 
 - **404** - plugin not found
3202 3202 
 - **500** - server error
3203 3203
3204 
-JSON Parameters:
3204 
+**JSON parameters**:
3205 3205
3206 3206 
 - **Name** - The new network's name. this is a mandatory field
3207 3207 
 - **CheckDuplicate** - Requests daemon to check for networks with same name
... ... 
@@ -3239,13 +3239,13 @@ Content-Type: application/json
3239 3239
3240 3240 
     HTTP/1.1 200 OK
3241 3241
3242 
-Status Codes:
3242 
+**Status codes**:
3243 3243
3244 3244 
 - **200** - no error
3245 3245 
 - **404** - network or container is not found
3246 3246 
 - **500** - Internal Server Error
3247 3247
3248 
-JSON Parameters:
3248 
+**JSON parameters**:
3249 3249
3250 3250 
 - **container** - container-id/name to be connected to the network
3251 3251
... ... 
@@ -3271,13 +3271,13 @@ Content-Type: application/json
3271 3271
3272 3272 
     HTTP/1.1 200 OK
3273 3273
3274 
-Status Codes:
3274 
+**Status codes**:
3275 3275
3276 3276 
 - **200** - no error
3277 3277 
 - **404** - network or container not found
3278 3278 
 - **500** - Internal Server Error
3279 3279
3280 
-JSON Parameters:
3280 
+**JSON parameters**:
3281 3281
3282 3282 
 - **Container** - container-id/name to be disconnected from a network
3283 3283 
 - **Force** - Force the container to disconnect from a network
... ... 
@@ -3296,7 +3296,7 @@ Instruct the driver to remove the network (`id`).
3296 3296
3297 3297 
     HTTP/1.1 204 No Content
3298 3298
3299 
-Status Codes
3299 
+**Status codes**:
3300 3300
3301 3301 
 -   **204** - no error
3302 3302 
 -   **404** - no such network