Add back the "old" networksettings fields that were removed,
but added back to maintain backward compatibility, in
https://github.com/docker/docker/pull/17538
Update network endpoint responses, with updated response
introduced in;
https://github.com/docker/docker/pull/17536
Added changes to v1.22 that were applied to the v1.21 / v1.20 docs
after the API bump(s);
https://github.com/docker/docker/pull/17085
https://github.com/docker/docker/pull/17127
https://github.com/docker/docker/pull/13707
Also fixed some mixed tab/spaces indentation
and Markdown formatting issues (causing code-blocks to
be rendered incorrectly)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
| ... | ... |
@@ -116,6 +116,16 @@ list of DNS options to be used in the container. |
| 116 | 116 |
* `GET /containers/json` will return `ImageID` of the image used by container. |
| 117 | 117 |
* `POST /exec/(name)/start` will now return an HTTP 409 when the container is either stopped or paused. |
| 118 | 118 |
* `GET /containers/(name)/json` now accepts a `size` parameter. Setting this parameter to '1' returns container size information in the `SizeRw` and `SizeRootFs` fields. |
| 119 |
+* `GET /containers/(name)/json` now returns a `NetworkSettings.Networks` field, |
|
| 120 |
+ detailing network settings per network. This field deprecates the |
|
| 121 |
+ `NetworkSettings.Gateway`, `NetworkSettings.IPAddress`, |
|
| 122 |
+ `NetworkSettings.IPPrefixLen`, and `NetworkSettings.MacAddress` fields, which |
|
| 123 |
+ are still returned for backward-compatibility, but will be removed in a future version. |
|
| 124 |
+* `GET /exec/(id)/json` now returns a `NetworkSettings.Networks` field, |
|
| 125 |
+ detailing networksettings per network. This field deprecates the |
|
| 126 |
+ `NetworkSettings.Gateway`, `NetworkSettings.IPAddress`, |
|
| 127 |
+ `NetworkSettings.IPPrefixLen`, and `NetworkSettings.MacAddress` fields, which |
|
| 128 |
+ are still returned for backward-compatibility, but will be removed in a future version. |
|
| 119 | 129 |
|
| 120 | 130 |
### v1.20 API changes |
| 121 | 131 |
|
| ... | ... |
@@ -217,7 +217,7 @@ Json Parameters: |
| 217 | 217 |
for the container. |
| 218 | 218 |
- **User** - A string value specifying the user inside the container. |
| 219 | 219 |
- **Memory** - Memory limit in bytes. |
| 220 |
-- **MemorySwap**- Total memory limit (memory + swap); set `-1` to disable swap |
|
| 220 |
+- **MemorySwap** - Total memory limit (memory + swap); set `-1` to disable swap |
|
| 221 | 221 |
You must use this with `memory` and make the swap value larger than `memory`. |
| 222 | 222 |
- **CpuShares** - An integer value containing the container's CPU Shares |
| 223 | 223 |
(ie. the relative weight vs other containers). |
| ... | ... |
@@ -2141,12 +2141,12 @@ Status Codes: |
| 2141 | 2141 |
|
| 2142 | 2142 |
`POST /exec/(id)/resize` |
| 2143 | 2143 |
|
| 2144 |
-Resizes the `tty` session used by the `exec` command `id`. |
|
| 2144 |
+Resizes the `tty` session used by the `exec` command `id`. The unit is number of characters. |
|
| 2145 | 2145 |
This API is valid only if `tty` was specified as part of creating and starting the `exec` command. |
| 2146 | 2146 |
|
| 2147 | 2147 |
**Example request**: |
| 2148 | 2148 |
|
| 2149 |
- POST /exec/e90e34656806/resize HTTP/1.1 |
|
| 2149 |
+ POST /exec/e90e34656806/resize?h=40&w=80 HTTP/1.1 |
|
| 2150 | 2150 |
Content-Type: text/plain |
| 2151 | 2151 |
|
| 2152 | 2152 |
**Example response**: |
| ... | ... |
@@ -2257,7 +2257,7 @@ Return low-level information about the `exec` command `id`. |
| 2257 | 2257 |
"ProcessLabel" : "", |
| 2258 | 2258 |
"AppArmorProfile" : "", |
| 2259 | 2259 |
"RestartCount" : 0, |
| 2260 |
- "Mounts" : [], |
|
| 2260 |
+ "Mounts" : [] |
|
| 2261 | 2261 |
} |
| 2262 | 2262 |
} |
| 2263 | 2263 |
|
| ... | ... |
@@ -46,7 +46,7 @@ List containers |
| 46 | 46 |
"Id": "8dfafdbc3a40", |
| 47 | 47 |
"Names":["/boring_feynman"], |
| 48 | 48 |
"Image": "ubuntu:latest", |
| 49 |
- "ImageID": "d74508fb6632491cea586a1fd7d748dfc5274cd6fdfedee309ecdcbc2bf5cb82", |
|
| 49 |
+ "ImageID": "d74508fb6632491cea586a1fd7d748dfc5274cd6fdfedee309ecdcbc2bf5cb82", |
|
| 50 | 50 |
"Command": "echo 1", |
| 51 | 51 |
"Created": 1367854155, |
| 52 | 52 |
"Status": "Exit 0", |
| ... | ... |
@@ -63,7 +63,7 @@ List containers |
| 63 | 63 |
"Id": "9cd87474be90", |
| 64 | 64 |
"Names":["/coolName"], |
| 65 | 65 |
"Image": "ubuntu:latest", |
| 66 |
- "ImageID": "d74508fb6632491cea586a1fd7d748dfc5274cd6fdfedee309ecdcbc2bf5cb82", |
|
| 66 |
+ "ImageID": "d74508fb6632491cea586a1fd7d748dfc5274cd6fdfedee309ecdcbc2bf5cb82", |
|
| 67 | 67 |
"Command": "echo 222222", |
| 68 | 68 |
"Created": 1367854155, |
| 69 | 69 |
"Status": "Exit 0", |
| ... | ... |
@@ -76,7 +76,7 @@ List containers |
| 76 | 76 |
"Id": "3176a2479c92", |
| 77 | 77 |
"Names":["/sleepy_dog"], |
| 78 | 78 |
"Image": "ubuntu:latest", |
| 79 |
- "ImageID": "d74508fb6632491cea586a1fd7d748dfc5274cd6fdfedee309ecdcbc2bf5cb82", |
|
| 79 |
+ "ImageID": "d74508fb6632491cea586a1fd7d748dfc5274cd6fdfedee309ecdcbc2bf5cb82", |
|
| 80 | 80 |
"Command": "echo 3333333333333333", |
| 81 | 81 |
"Created": 1367854154, |
| 82 | 82 |
"Status": "Exit 0", |
| ... | ... |
@@ -89,7 +89,7 @@ List containers |
| 89 | 89 |
"Id": "4cb07b47f9fb", |
| 90 | 90 |
"Names":["/running_cat"], |
| 91 | 91 |
"Image": "ubuntu:latest", |
| 92 |
- "ImageID": "d74508fb6632491cea586a1fd7d748dfc5274cd6fdfedee309ecdcbc2bf5cb82", |
|
| 92 |
+ "ImageID": "d74508fb6632491cea586a1fd7d748dfc5274cd6fdfedee309ecdcbc2bf5cb82", |
|
| 93 | 93 |
"Command": "echo 444444444444444444444444444444444", |
| 94 | 94 |
"Created": 1367854152, |
| 95 | 95 |
"Status": "Exit 0", |
| ... | ... |
@@ -204,7 +204,7 @@ Create a container |
| 204 | 204 |
"LogConfig": { "Type": "json-file", "Config": {} },
|
| 205 | 205 |
"SecurityOpt": [""], |
| 206 | 206 |
"CgroupParent": "", |
| 207 |
- "VolumeDriver": "" |
|
| 207 |
+ "VolumeDriver": "" |
|
| 208 | 208 |
} |
| 209 | 209 |
} |
| 210 | 210 |
|
| ... | ... |
@@ -441,15 +441,23 @@ Return low-level information on the container `id` |
| 441 | 441 |
"HairpinMode": false, |
| 442 | 442 |
"LinkLocalIPv6Address": "", |
| 443 | 443 |
"LinkLocalIPv6PrefixLen": 0, |
| 444 |
- "SandboxKey": "", |
|
| 445 |
- "SecondaryIPAddresses": [], |
|
| 446 |
- "SecondaryIPv6Addresses": [], |
|
| 447 | 444 |
"Ports": null, |
| 445 |
+ "SandboxKey": "", |
|
| 446 |
+ "SecondaryIPAddresses": null, |
|
| 447 |
+ "SecondaryIPv6Addresses": null, |
|
| 448 |
+ "EndpointID": "", |
|
| 449 |
+ "Gateway": "", |
|
| 450 |
+ "GlobalIPv6Address": "", |
|
| 451 |
+ "GlobalIPv6PrefixLen": 0, |
|
| 452 |
+ "IPAddress": "", |
|
| 453 |
+ "IPPrefixLen": 0, |
|
| 454 |
+ "IPv6Gateway": "", |
|
| 455 |
+ "MacAddress": "", |
|
| 448 | 456 |
"Networks": {
|
| 449 | 457 |
"bridge": {
|
| 450 | 458 |
"EndpointID": "", |
| 451 | 459 |
"Gateway": "", |
| 452 |
- "IPAdress": "", |
|
| 460 |
+ "IPAddress": "", |
|
| 453 | 461 |
"IPPrefixLen": 0, |
| 454 | 462 |
"IPv6Gateway": "", |
| 455 | 463 |
"GlobalIPv6Address": "", |
| ... | ... |
@@ -562,7 +570,7 @@ Status Codes: |
| 562 | 562 |
Get `stdout` and `stderr` logs from the container ``id`` |
| 563 | 563 |
|
| 564 | 564 |
> **Note**: |
| 565 |
-> This endpoint works only for containers with `json-file` logging driver. |
|
| 565 |
+> This endpoint works only for containers with the `json-file` or `journald` logging drivers. |
|
| 566 | 566 |
|
| 567 | 567 |
**Example request**: |
| 568 | 568 |
|
| ... | ... |
@@ -1244,14 +1252,14 @@ Query Parameters: |
| 1244 | 1244 |
|
| 1245 | 1245 |
**Example request**: |
| 1246 | 1246 |
|
| 1247 |
- PUT /containers/8cce319429b2/archive?path=/vol1 HTTP/1.1 |
|
| 1248 |
- Content-Type: application/x-tar |
|
| 1247 |
+ PUT /containers/8cce319429b2/archive?path=/vol1 HTTP/1.1 |
|
| 1248 |
+ Content-Type: application/x-tar |
|
| 1249 | 1249 |
|
| 1250 |
- {{ TAR STREAM }}
|
|
| 1250 |
+ {{ TAR STREAM }}
|
|
| 1251 | 1251 |
|
| 1252 | 1252 |
**Example response**: |
| 1253 | 1253 |
|
| 1254 |
- HTTP/1.1 200 OK |
|
| 1254 |
+ HTTP/1.1 200 OK |
|
| 1255 | 1255 |
|
| 1256 | 1256 |
Status Codes: |
| 1257 | 1257 |
|
| ... | ... |
@@ -2384,29 +2392,37 @@ Return low-level information about the `exec` command `id`. |
| 2384 | 2384 |
"SecurityOpt" : null |
| 2385 | 2385 |
}, |
| 2386 | 2386 |
"Image" : "5506de2b643be1e6febbf3b8a240760c6843244c41e12aa2f60ccbb7153d17f5", |
| 2387 |
- "NetworkSettings": {
|
|
| 2388 |
- "Bridge": "", |
|
| 2389 |
- "SandboxID": "", |
|
| 2390 |
- "HairpinMode": false, |
|
| 2391 |
- "LinkLocalIPv6Address": "", |
|
| 2392 |
- "LinkLocalIPv6PrefixLen": 0, |
|
| 2393 |
- "SandboxKey": "", |
|
| 2394 |
- "SecondaryIPAddresses": [], |
|
| 2395 |
- "SecondaryIPv6Addresses": [], |
|
| 2396 |
- "Ports": null, |
|
| 2397 |
- "Networks": {
|
|
| 2398 |
- "bridge": {
|
|
| 2399 |
- "EndpointID": "", |
|
| 2400 |
- "Gateway": "", |
|
| 2401 |
- "IPAdress": "", |
|
| 2402 |
- "IPPrefixLen": 0, |
|
| 2403 |
- "IPv6Gateway": "", |
|
| 2404 |
- "GlobalIPv6Address": "", |
|
| 2405 |
- "GlobalIPv6PrefixLen": 0, |
|
| 2406 |
- "MacAddress": "" |
|
| 2407 |
- } |
|
| 2408 |
- } |
|
| 2409 |
- }, |
|
| 2387 |
+ "NetworkSettings": {
|
|
| 2388 |
+ "Bridge": "", |
|
| 2389 |
+ "SandboxID": "", |
|
| 2390 |
+ "HairpinMode": false, |
|
| 2391 |
+ "LinkLocalIPv6Address": "", |
|
| 2392 |
+ "LinkLocalIPv6PrefixLen": 0, |
|
| 2393 |
+ "Ports": null, |
|
| 2394 |
+ "SandboxKey": "", |
|
| 2395 |
+ "SecondaryIPAddresses": null, |
|
| 2396 |
+ "SecondaryIPv6Addresses": null, |
|
| 2397 |
+ "EndpointID": "", |
|
| 2398 |
+ "Gateway": "", |
|
| 2399 |
+ "GlobalIPv6Address": "", |
|
| 2400 |
+ "GlobalIPv6PrefixLen": 0, |
|
| 2401 |
+ "IPAddress": "", |
|
| 2402 |
+ "IPPrefixLen": 0, |
|
| 2403 |
+ "IPv6Gateway": "", |
|
| 2404 |
+ "MacAddress": "", |
|
| 2405 |
+ "Networks": {
|
|
| 2406 |
+ "bridge": {
|
|
| 2407 |
+ "EndpointID": "", |
|
| 2408 |
+ "Gateway": "", |
|
| 2409 |
+ "IPAddress": "", |
|
| 2410 |
+ "IPPrefixLen": 0, |
|
| 2411 |
+ "IPv6Gateway": "", |
|
| 2412 |
+ "GlobalIPv6Address": "", |
|
| 2413 |
+ "GlobalIPv6PrefixLen": 0, |
|
| 2414 |
+ "MacAddress": "" |
|
| 2415 |
+ } |
|
| 2416 |
+ } |
|
| 2417 |
+ }, |
|
| 2410 | 2418 |
"ResolvConfPath" : "/var/lib/docker/containers/8f177a186b977fb451136e0fdf182abff5599a08b3c7f6ef0d36a55aaf89634c/resolv.conf", |
| 2411 | 2419 |
"HostnamePath" : "/var/lib/docker/containers/8f177a186b977fb451136e0fdf182abff5599a08b3c7f6ef0d36a55aaf89634c/hostname", |
| 2412 | 2420 |
"HostsPath" : "/var/lib/docker/containers/8f177a186b977fb451136e0fdf182abff5599a08b3c7f6ef0d36a55aaf89634c/hosts", |
| ... | ... |
@@ -2436,22 +2452,22 @@ Status Codes: |
| 2436 | 2436 |
|
| 2437 | 2437 |
**Example request**: |
| 2438 | 2438 |
|
| 2439 |
- GET /volumes HTTP/1.1 |
|
| 2439 |
+ GET /volumes HTTP/1.1 |
|
| 2440 | 2440 |
|
| 2441 | 2441 |
**Example response**: |
| 2442 | 2442 |
|
| 2443 |
- HTTP/1.1 200 OK |
|
| 2444 |
- Content-Type: application/json |
|
| 2443 |
+ HTTP/1.1 200 OK |
|
| 2444 |
+ Content-Type: application/json |
|
| 2445 | 2445 |
|
| 2446 |
- {
|
|
| 2447 |
- "Volumes": [ |
|
| 2448 |
- {
|
|
| 2449 |
- "Name": "tardis", |
|
| 2450 |
- "Driver": "local", |
|
| 2451 |
- "Mountpoint": "/var/lib/docker/volumes/tardis" |
|
| 2452 |
- } |
|
| 2453 |
- ] |
|
| 2454 |
- } |
|
| 2446 |
+ {
|
|
| 2447 |
+ "Volumes": [ |
|
| 2448 |
+ {
|
|
| 2449 |
+ "Name": "tardis", |
|
| 2450 |
+ "Driver": "local", |
|
| 2451 |
+ "Mountpoint": "/var/lib/docker/volumes/tardis" |
|
| 2452 |
+ } |
|
| 2453 |
+ ] |
|
| 2454 |
+ } |
|
| 2455 | 2455 |
|
| 2456 | 2456 |
Query Parameters: |
| 2457 | 2457 |
|
| ... | ... |
@@ -2470,23 +2486,23 @@ Create a volume |
| 2470 | 2470 |
|
| 2471 | 2471 |
**Example request**: |
| 2472 | 2472 |
|
| 2473 |
- POST /volumes/create HTTP/1.1 |
|
| 2474 |
- Content-Type: application/json |
|
| 2473 |
+ POST /volumes/create HTTP/1.1 |
|
| 2474 |
+ Content-Type: application/json |
|
| 2475 | 2475 |
|
| 2476 |
- {
|
|
| 2477 |
- "Name": "tardis" |
|
| 2478 |
- } |
|
| 2476 |
+ {
|
|
| 2477 |
+ "Name": "tardis" |
|
| 2478 |
+ } |
|
| 2479 | 2479 |
|
| 2480 | 2480 |
**Example response**: |
| 2481 | 2481 |
|
| 2482 |
- HTTP/1.1 201 Created |
|
| 2483 |
- Content-Type: application/json |
|
| 2482 |
+ HTTP/1.1 201 Created |
|
| 2483 |
+ Content-Type: application/json |
|
| 2484 | 2484 |
|
| 2485 |
- {
|
|
| 2486 |
- "Name": "tardis" |
|
| 2487 |
- "Driver": "local", |
|
| 2488 |
- "Mountpoint": "/var/lib/docker/volumes/tardis" |
|
| 2489 |
- } |
|
| 2485 |
+ {
|
|
| 2486 |
+ "Name": "tardis", |
|
| 2487 |
+ "Driver": "local", |
|
| 2488 |
+ "Mountpoint": "/var/lib/docker/volumes/tardis" |
|
| 2489 |
+ } |
|
| 2490 | 2490 |
|
| 2491 | 2491 |
Status Codes: |
| 2492 | 2492 |
|
| ... | ... |
@@ -2512,14 +2528,14 @@ Return low-level information on the volume `name` |
| 2512 | 2512 |
|
| 2513 | 2513 |
**Example response**: |
| 2514 | 2514 |
|
| 2515 |
- HTTP/1.1 200 OK |
|
| 2516 |
- Content-Type: application/json |
|
| 2515 |
+ HTTP/1.1 200 OK |
|
| 2516 |
+ Content-Type: application/json |
|
| 2517 | 2517 |
|
| 2518 |
- {
|
|
| 2519 |
- "Name": "tardis", |
|
| 2520 |
- "Driver": "local", |
|
| 2521 |
- "Mountpoint": "/var/lib/docker/volumes/tardis" |
|
| 2522 |
- } |
|
| 2518 |
+ {
|
|
| 2519 |
+ "Name": "tardis", |
|
| 2520 |
+ "Driver": "local", |
|
| 2521 |
+ "Mountpoint": "/var/lib/docker/volumes/tardis" |
|
| 2522 |
+ } |
|
| 2523 | 2523 |
|
| 2524 | 2524 |
Status Codes: |
| 2525 | 2525 |
|
| ... | ... |
@@ -2535,11 +2551,11 @@ Instruct the driver to remove the volume (`name`). |
| 2535 | 2535 |
|
| 2536 | 2536 |
**Example request**: |
| 2537 | 2537 |
|
| 2538 |
- DELETE /volumes/local/tardis HTTP/1.1 |
|
| 2538 |
+ DELETE /volumes/local/tardis HTTP/1.1 |
|
| 2539 | 2539 |
|
| 2540 | 2540 |
**Example response**: |
| 2541 | 2541 |
|
| 2542 |
- HTTP/1.1 204 No Content |
|
| 2542 |
+ HTTP/1.1 204 No Content |
|
| 2543 | 2543 |
|
| 2544 | 2544 |
Status Codes |
| 2545 | 2545 |
|
| ... | ... |
@@ -2556,34 +2572,70 @@ Status Codes |
| 2556 | 2556 |
|
| 2557 | 2557 |
**Example request**: |
| 2558 | 2558 |
|
| 2559 |
- GET /networks HTTP/1.1 |
|
| 2559 |
+ GET /networks HTTP/1.1 |
|
| 2560 | 2560 |
|
| 2561 | 2561 |
**Example response**: |
| 2562 | 2562 |
|
| 2563 |
- HTTP/1.1 200 OK |
|
| 2564 |
- Content-Type: application/json |
|
| 2565 |
- |
|
| 2566 | 2563 |
``` |
| 2567 |
- [ |
|
| 2568 |
- {
|
|
| 2569 |
- "name": "bridge", |
|
| 2570 |
- "id": "f995e41e471c833266786a64df584fbe4dc654ac99f63a4ee7495842aa093fc4", |
|
| 2571 |
- "driver": "bridge", |
|
| 2572 |
- "containers": {}
|
|
| 2564 |
+HTTP/1.1 200 OK |
|
| 2565 |
+Content-Type: application/json |
|
| 2566 |
+ |
|
| 2567 |
+[ |
|
| 2568 |
+ {
|
|
| 2569 |
+ "Name": "bridge", |
|
| 2570 |
+ "Id": "f2de39df4171b0dc801e8002d1d999b77256983dfc63041c0f34030aa3977566", |
|
| 2571 |
+ "Scope": "local", |
|
| 2572 |
+ "Driver": "bridge", |
|
| 2573 |
+ "IPAM": {
|
|
| 2574 |
+ "Driver": "default", |
|
| 2575 |
+ "Config": [ |
|
| 2576 |
+ {
|
|
| 2577 |
+ "Subnet": "172.17.0.0/16" |
|
| 2578 |
+ } |
|
| 2579 |
+ ] |
|
| 2573 | 2580 |
}, |
| 2574 |
- {
|
|
| 2575 |
- "name": "none", |
|
| 2576 |
- "id": "21e34df9b29c74ae45ba312f8e9f83c02433c9a877cfebebcf57be78f69b77c8", |
|
| 2577 |
- "driver": "null", |
|
| 2578 |
- "containers": {}
|
|
| 2581 |
+ "Containers": {
|
|
| 2582 |
+ "39b69226f9d79f5634485fb236a23b2fe4e96a0a94128390a7fbbcc167065867": {
|
|
| 2583 |
+ "EndpointID": "ed2419a97c1d9954d05b46e462e7002ea552f216e9b136b80a7db8d98b442eda", |
|
| 2584 |
+ "MacAddress": "02:42:ac:11:00:02", |
|
| 2585 |
+ "IPv4Address": "172.17.0.2/16", |
|
| 2586 |
+ "IPv6Address": "" |
|
| 2587 |
+ } |
|
| 2579 | 2588 |
}, |
| 2580 |
- {
|
|
| 2581 |
- "name": "host", |
|
| 2582 |
- "id": "3f43a0873f00310a71cd6a71e2e60c113cf17d1812be2ec22fd519fbac68ec91", |
|
| 2583 |
- "driver": "host", |
|
| 2584 |
- "containers": {}
|
|
| 2589 |
+ "Options": {
|
|
| 2590 |
+ "com.docker.network.bridge.default_bridge": "true", |
|
| 2591 |
+ "com.docker.network.bridge.enable_icc": "true", |
|
| 2592 |
+ "com.docker.network.bridge.enable_ip_masquerade": "true", |
|
| 2593 |
+ "com.docker.network.bridge.host_binding_ipv4": "0.0.0.0", |
|
| 2594 |
+ "com.docker.network.bridge.name": "docker0", |
|
| 2595 |
+ "com.docker.network.driver.mtu": "1500" |
|
| 2585 | 2596 |
} |
| 2586 |
- ] |
|
| 2597 |
+ }, |
|
| 2598 |
+ {
|
|
| 2599 |
+ "Name": "none", |
|
| 2600 |
+ "Id": "e086a3893b05ab69242d3c44e49483a3bbbd3a26b46baa8f61ab797c1088d794", |
|
| 2601 |
+ "Scope": "local", |
|
| 2602 |
+ "Driver": "null", |
|
| 2603 |
+ "IPAM": {
|
|
| 2604 |
+ "Driver": "default", |
|
| 2605 |
+ "Config": [] |
|
| 2606 |
+ }, |
|
| 2607 |
+ "Containers": {},
|
|
| 2608 |
+ "Options": {}
|
|
| 2609 |
+ }, |
|
| 2610 |
+ {
|
|
| 2611 |
+ "Name": "host", |
|
| 2612 |
+ "Id": "13e871235c677f196c4e1ecebb9dc733b9b2d2ab589e30c539efeda84a24215e", |
|
| 2613 |
+ "Scope": "local", |
|
| 2614 |
+ "Driver": "host", |
|
| 2615 |
+ "IPAM": {
|
|
| 2616 |
+ "Driver": "default", |
|
| 2617 |
+ "Config": [] |
|
| 2618 |
+ }, |
|
| 2619 |
+ "Containers": {},
|
|
| 2620 |
+ "Options": {}
|
|
| 2621 |
+ } |
|
| 2622 |
+] |
|
| 2587 | 2623 |
``` |
| 2588 | 2624 |
|
| 2589 | 2625 |
|
| ... | ... |
@@ -2603,39 +2655,44 @@ Status Codes: |
| 2603 | 2603 |
|
| 2604 | 2604 |
**Example request**: |
| 2605 | 2605 |
|
| 2606 |
- GET /networks/f995e41e471c833266786a64df584fbe4dc654ac99f63a4ee7495842aa093fc4 HTTP/1.1 |
|
| 2606 |
+ GET /networks/f2de39df4171b0dc801e8002d1d999b77256983dfc63041c0f34030aa3977566 HTTP/1.1 |
|
| 2607 | 2607 |
|
| 2608 | 2608 |
**Example response**: |
| 2609 | 2609 |
|
| 2610 |
- HTTP/1.1 200 OK |
|
| 2611 |
- Content-Type: application/json |
|
| 2612 |
- |
|
| 2613 | 2610 |
``` |
| 2614 |
- {
|
|
| 2615 |
- "name": "bridge", |
|
| 2616 |
- "id": "f995e41e471c833266786a64df584fbe4dc654ac99f63a4ee7495842aa093fc4", |
|
| 2617 |
- "driver": "bridge", |
|
| 2618 |
- "containers": {
|
|
| 2619 |
- "931d29e96e63022a3691f55ca18b28600239acf53878451975f77054b05ba559": {
|
|
| 2620 |
- "endpoint": "aa79321e2899e6d72fcd46e6a4ad7f81ab9a19c3b06e384ef4ce51fea35827f9", |
|
| 2621 |
- "mac_address": "02:42:ac:11:00:04", |
|
| 2622 |
- "ipv4_address": "172.17.0.4/16", |
|
| 2623 |
- "ipv6_address": "" |
|
| 2624 |
- }, |
|
| 2625 |
- "961249b4ae6c764b11eed923e8463c102689111fffd933627b2e7e359c7d0f7c": {
|
|
| 2626 |
- "endpoint": "4f62c5aea6b9a70512210be7db976bd4ec2cdba47125e4fe514d18c81b1624b1", |
|
| 2627 |
- "mac_address": "02:42:ac:11:00:02", |
|
| 2628 |
- "ipv4_address": "172.17.0.2/16", |
|
| 2629 |
- "ipv6_address": "" |
|
| 2630 |
- }, |
|
| 2631 |
- "9f6e0fec4449f42a173ed85be96dc2253b6719edd850d8169bc31bdc45db675c": {
|
|
| 2632 |
- "endpoint": "352b512a5bccdfc77d16c2c04d04408e718f879a16f9ce3913a4733139e4f98d", |
|
| 2633 |
- "mac_address": "02:42:ac:11:00:03", |
|
| 2634 |
- "ipv4_address": "172.17.0.3/16", |
|
| 2635 |
- "ipv6_address": "" |
|
| 2611 |
+HTTP/1.1 200 OK |
|
| 2612 |
+Content-Type: application/json |
|
| 2613 |
+ |
|
| 2614 |
+{
|
|
| 2615 |
+ "Name": "bridge", |
|
| 2616 |
+ "Id": "f2de39df4171b0dc801e8002d1d999b77256983dfc63041c0f34030aa3977566", |
|
| 2617 |
+ "Scope": "local", |
|
| 2618 |
+ "Driver": "bridge", |
|
| 2619 |
+ "IPAM": {
|
|
| 2620 |
+ "Driver": "default", |
|
| 2621 |
+ "Config": [ |
|
| 2622 |
+ {
|
|
| 2623 |
+ "Subnet": "172.17.0.0/16" |
|
| 2636 | 2624 |
} |
| 2625 |
+ ] |
|
| 2626 |
+ }, |
|
| 2627 |
+ "Containers": {
|
|
| 2628 |
+ "39b69226f9d79f5634485fb236a23b2fe4e96a0a94128390a7fbbcc167065867": {
|
|
| 2629 |
+ "EndpointID": "ed2419a97c1d9954d05b46e462e7002ea552f216e9b136b80a7db8d98b442eda", |
|
| 2630 |
+ "MacAddress": "02:42:ac:11:00:02", |
|
| 2631 |
+ "IPv4Address": "172.17.0.2/16", |
|
| 2632 |
+ "IPv6Address": "" |
|
| 2637 | 2633 |
} |
| 2634 |
+ }, |
|
| 2635 |
+ "Options": {
|
|
| 2636 |
+ "com.docker.network.bridge.default_bridge": "true", |
|
| 2637 |
+ "com.docker.network.bridge.enable_icc": "true", |
|
| 2638 |
+ "com.docker.network.bridge.enable_ip_masquerade": "true", |
|
| 2639 |
+ "com.docker.network.bridge.host_binding_ipv4": "0.0.0.0", |
|
| 2640 |
+ "com.docker.network.bridge.name": "docker0", |
|
| 2641 |
+ "com.docker.network.driver.mtu": "1500" |
|
| 2638 | 2642 |
} |
| 2643 |
+} |
|
| 2639 | 2644 |
``` |
| 2640 | 2645 |
|
| 2641 | 2646 |
Status Codes: |
| ... | ... |
@@ -2651,26 +2708,26 @@ Create a network |
| 2651 | 2651 |
|
| 2652 | 2652 |
**Example request**: |
| 2653 | 2653 |
|
| 2654 |
- POST /networks/create HTTP/1.1 |
|
| 2655 |
- Content-Type: application/json |
|
| 2656 |
- |
|
| 2657 | 2654 |
``` |
| 2658 |
- {
|
|
| 2659 |
- "name":"isolated_nw", |
|
| 2660 |
- "driver":"bridge" |
|
| 2661 |
- } |
|
| 2655 |
+POST /networks/create HTTP/1.1 |
|
| 2656 |
+Content-Type: application/json |
|
| 2657 |
+ |
|
| 2658 |
+{
|
|
| 2659 |
+ "Name":"isolated_nw", |
|
| 2660 |
+ "Driver":"bridge" |
|
| 2661 |
+} |
|
| 2662 | 2662 |
``` |
| 2663 | 2663 |
|
| 2664 | 2664 |
**Example response**: |
| 2665 | 2665 |
|
| 2666 |
- HTTP/1.1 201 Created |
|
| 2667 |
- Content-Type: application/json |
|
| 2668 |
- |
|
| 2669 | 2666 |
``` |
| 2670 |
- {
|
|
| 2671 |
- "id": "22be93d5babb089c5aab8dbc369042fad48ff791584ca2da2100db837a1c7c30", |
|
| 2672 |
- "warning": "" |
|
| 2673 |
- } |
|
| 2667 |
+HTTP/1.1 201 Created |
|
| 2668 |
+Content-Type: application/json |
|
| 2669 |
+ |
|
| 2670 |
+{
|
|
| 2671 |
+ "Id": "22be93d5babb089c5aab8dbc369042fad48ff791584ca2da2100db837a1c7c30", |
|
| 2672 |
+ "Warning": "" |
|
| 2673 |
+} |
|
| 2674 | 2674 |
``` |
| 2675 | 2675 |
|
| 2676 | 2676 |
Status Codes: |
| ... | ... |
@@ -2681,10 +2738,10 @@ Status Codes: |
| 2681 | 2681 |
|
| 2682 | 2682 |
JSON Parameters: |
| 2683 | 2683 |
|
| 2684 |
-- **name** - The new network's name. this is a mandatory field |
|
| 2685 |
-- **driver** - Name of the network driver to use. Defaults to `bridge` driver |
|
| 2686 |
-- **options** - Network specific options to be used by the drivers |
|
| 2687 |
-- **check_duplicate** - Requests daemon to check for networks with same name |
|
| 2684 |
+- **Name** - The new network's name. this is a mandatory field |
|
| 2685 |
+- **Driver** - Name of the network driver to use. Defaults to `bridge` driver |
|
| 2686 |
+- **Options** - Network specific options to be used by the drivers |
|
| 2687 |
+- **CheckDuplicate** - Requests daemon to check for networks with same name |
|
| 2688 | 2688 |
|
| 2689 | 2689 |
### Connect a container to a network |
| 2690 | 2690 |
|
| ... | ... |
@@ -2694,18 +2751,18 @@ Connects a container to a network |
| 2694 | 2694 |
|
| 2695 | 2695 |
**Example request**: |
| 2696 | 2696 |
|
| 2697 |
- POST /networks/22be93d5babb089c5aab8dbc369042fad48ff791584ca2da2100db837a1c7c30/connect HTTP/1.1 |
|
| 2698 |
- Content-Type: application/json |
|
| 2699 |
- |
|
| 2700 | 2697 |
``` |
| 2701 |
- {
|
|
| 2702 |
- "container":"3613f73ba0e4" |
|
| 2703 |
- } |
|
| 2698 |
+POST /networks/22be93d5babb089c5aab8dbc369042fad48ff791584ca2da2100db837a1c7c30/connect HTTP/1.1 |
|
| 2699 |
+Content-Type: application/json |
|
| 2700 |
+ |
|
| 2701 |
+{
|
|
| 2702 |
+ "Container":"3613f73ba0e4" |
|
| 2703 |
+} |
|
| 2704 | 2704 |
``` |
| 2705 | 2705 |
|
| 2706 | 2706 |
**Example response**: |
| 2707 | 2707 |
|
| 2708 |
- HTTP/1.1 200 OK |
|
| 2708 |
+ HTTP/1.1 200 OK |
|
| 2709 | 2709 |
|
| 2710 | 2710 |
Status Codes: |
| 2711 | 2711 |
|
| ... | ... |
@@ -2724,18 +2781,18 @@ Disconnects a container from a network |
| 2724 | 2724 |
|
| 2725 | 2725 |
**Example request**: |
| 2726 | 2726 |
|
| 2727 |
- POST /networks/22be93d5babb089c5aab8dbc369042fad48ff791584ca2da2100db837a1c7c30/disconnect HTTP/1.1 |
|
| 2728 |
- Content-Type: application/json |
|
| 2729 |
- |
|
| 2730 | 2727 |
``` |
| 2731 |
- {
|
|
| 2732 |
- "container":"3613f73ba0e4" |
|
| 2733 |
- } |
|
| 2728 |
+POST /networks/22be93d5babb089c5aab8dbc369042fad48ff791584ca2da2100db837a1c7c30/disconnect HTTP/1.1 |
|
| 2729 |
+Content-Type: application/json |
|
| 2730 |
+ |
|
| 2731 |
+{
|
|
| 2732 |
+ "Container":"3613f73ba0e4" |
|
| 2733 |
+} |
|
| 2734 | 2734 |
``` |
| 2735 | 2735 |
|
| 2736 | 2736 |
**Example response**: |
| 2737 | 2737 |
|
| 2738 |
- HTTP/1.1 200 OK |
|
| 2738 |
+ HTTP/1.1 200 OK |
|
| 2739 | 2739 |
|
| 2740 | 2740 |
Status Codes: |
| 2741 | 2741 |
|
| ... | ... |
@@ -2744,7 +2801,7 @@ Status Codes: |
| 2744 | 2744 |
|
| 2745 | 2745 |
JSON Parameters: |
| 2746 | 2746 |
|
| 2747 |
-- **container** - container-id/name to be disconnected from a network |
|
| 2747 |
+- **Container** - container-id/name to be disconnected from a network |
|
| 2748 | 2748 |
|
| 2749 | 2749 |
### Remove a network |
| 2750 | 2750 |
|
| ... | ... |
@@ -2754,11 +2811,11 @@ Instruct the driver to remove the network (`id`). |
| 2754 | 2754 |
|
| 2755 | 2755 |
**Example request**: |
| 2756 | 2756 |
|
| 2757 |
- DELETE /networks/22be93d5babb089c5aab8dbc369042fad48ff791584ca2da2100db837a1c7c30 HTTP/1.1 |
|
| 2757 |
+ DELETE /networks/22be93d5babb089c5aab8dbc369042fad48ff791584ca2da2100db837a1c7c30 HTTP/1.1 |
|
| 2758 | 2758 |
|
| 2759 | 2759 |
**Example response**: |
| 2760 | 2760 |
|
| 2761 |
- HTTP/1.1 204 No Content |
|
| 2761 |
+ HTTP/1.1 204 No Content |
|
| 2762 | 2762 |
|
| 2763 | 2763 |
Status Codes |
| 2764 | 2764 |
|
| ... | ... |
@@ -47,7 +47,7 @@ List containers |
| 47 | 47 |
"Id": "8dfafdbc3a40", |
| 48 | 48 |
"Names":["/boring_feynman"], |
| 49 | 49 |
"Image": "ubuntu:latest", |
| 50 |
- "ImageID": "d74508fb6632491cea586a1fd7d748dfc5274cd6fdfedee309ecdcbc2bf5cb82", |
|
| 50 |
+ "ImageID": "d74508fb6632491cea586a1fd7d748dfc5274cd6fdfedee309ecdcbc2bf5cb82", |
|
| 51 | 51 |
"Command": "echo 1", |
| 52 | 52 |
"Created": 1367854155, |
| 53 | 53 |
"Status": "Exit 0", |
| ... | ... |
@@ -64,7 +64,7 @@ List containers |
| 64 | 64 |
"Id": "9cd87474be90", |
| 65 | 65 |
"Names":["/coolName"], |
| 66 | 66 |
"Image": "ubuntu:latest", |
| 67 |
- "ImageID": "d74508fb6632491cea586a1fd7d748dfc5274cd6fdfedee309ecdcbc2bf5cb82", |
|
| 67 |
+ "ImageID": "d74508fb6632491cea586a1fd7d748dfc5274cd6fdfedee309ecdcbc2bf5cb82", |
|
| 68 | 68 |
"Command": "echo 222222", |
| 69 | 69 |
"Created": 1367854155, |
| 70 | 70 |
"Status": "Exit 0", |
| ... | ... |
@@ -77,7 +77,7 @@ List containers |
| 77 | 77 |
"Id": "3176a2479c92", |
| 78 | 78 |
"Names":["/sleepy_dog"], |
| 79 | 79 |
"Image": "ubuntu:latest", |
| 80 |
- "ImageID": "d74508fb6632491cea586a1fd7d748dfc5274cd6fdfedee309ecdcbc2bf5cb82", |
|
| 80 |
+ "ImageID": "d74508fb6632491cea586a1fd7d748dfc5274cd6fdfedee309ecdcbc2bf5cb82", |
|
| 81 | 81 |
"Command": "echo 3333333333333333", |
| 82 | 82 |
"Created": 1367854154, |
| 83 | 83 |
"Status": "Exit 0", |
| ... | ... |
@@ -90,7 +90,7 @@ List containers |
| 90 | 90 |
"Id": "4cb07b47f9fb", |
| 91 | 91 |
"Names":["/running_cat"], |
| 92 | 92 |
"Image": "ubuntu:latest", |
| 93 |
- "ImageID": "d74508fb6632491cea586a1fd7d748dfc5274cd6fdfedee309ecdcbc2bf5cb82", |
|
| 93 |
+ "ImageID": "d74508fb6632491cea586a1fd7d748dfc5274cd6fdfedee309ecdcbc2bf5cb82", |
|
| 94 | 94 |
"Command": "echo 444444444444444444444444444444444", |
| 95 | 95 |
"Created": 1367854152, |
| 96 | 96 |
"Status": "Exit 0", |
| ... | ... |
@@ -205,7 +205,7 @@ Create a container |
| 205 | 205 |
"LogConfig": { "Type": "json-file", "Config": {} },
|
| 206 | 206 |
"SecurityOpt": [""], |
| 207 | 207 |
"CgroupParent": "", |
| 208 |
- "VolumeDriver": "" |
|
| 208 |
+ "VolumeDriver": "" |
|
| 209 | 209 |
} |
| 210 | 210 |
} |
| 211 | 211 |
|
| ... | ... |
@@ -266,6 +266,8 @@ Json Parameters: |
| 266 | 266 |
+ `container_path` to create a new volume for the container |
| 267 | 267 |
+ `host_path:container_path` to bind-mount a host path into the container |
| 268 | 268 |
+ `host_path:container_path:ro` to make the bind-mount read-only inside the container. |
| 269 |
+ + `volume_name:container_path` to bind-mount a volume managed by a volume plugin into the container. |
|
| 270 |
+ + `volume_name:container_path:ro` to make the bind mount read-only inside the container. |
|
| 269 | 271 |
- **Links** - A list of links for the container. Each link entry should be |
| 270 | 272 |
in the form of `container_name:alias`. |
| 271 | 273 |
- **LxcConf** - LXC specific configurations. These configurations only |
| ... | ... |
@@ -440,15 +442,23 @@ Return low-level information on the container `id` |
| 440 | 440 |
"HairpinMode": false, |
| 441 | 441 |
"LinkLocalIPv6Address": "", |
| 442 | 442 |
"LinkLocalIPv6PrefixLen": 0, |
| 443 |
- "SandboxKey": "", |
|
| 444 |
- "SecondaryIPAddresses": [], |
|
| 445 |
- "SecondaryIPv6Addresses": [], |
|
| 446 | 443 |
"Ports": null, |
| 444 |
+ "SandboxKey": "", |
|
| 445 |
+ "SecondaryIPAddresses": null, |
|
| 446 |
+ "SecondaryIPv6Addresses": null, |
|
| 447 |
+ "EndpointID": "", |
|
| 448 |
+ "Gateway": "", |
|
| 449 |
+ "GlobalIPv6Address": "", |
|
| 450 |
+ "GlobalIPv6PrefixLen": 0, |
|
| 451 |
+ "IPAddress": "", |
|
| 452 |
+ "IPPrefixLen": 0, |
|
| 453 |
+ "IPv6Gateway": "", |
|
| 454 |
+ "MacAddress": "", |
|
| 447 | 455 |
"Networks": {
|
| 448 | 456 |
"bridge": {
|
| 449 | 457 |
"EndpointID": "", |
| 450 | 458 |
"Gateway": "", |
| 451 |
- "IPAdress": "", |
|
| 459 |
+ "IPAddress": "", |
|
| 452 | 460 |
"IPPrefixLen": 0, |
| 453 | 461 |
"IPv6Gateway": "", |
| 454 | 462 |
"GlobalIPv6Address": "", |
| ... | ... |
@@ -561,7 +571,7 @@ Status Codes: |
| 561 | 561 |
Get `stdout` and `stderr` logs from the container ``id`` |
| 562 | 562 |
|
| 563 | 563 |
> **Note**: |
| 564 |
-> This endpoint works only for containers with `json-file` logging driver. |
|
| 564 |
+> This endpoint works only for containers with the `json-file` or `journald` logging drivers. |
|
| 565 | 565 |
|
| 566 | 566 |
**Example request**: |
| 567 | 567 |
|
| ... | ... |
@@ -1243,14 +1253,14 @@ Query Parameters: |
| 1243 | 1243 |
|
| 1244 | 1244 |
**Example request**: |
| 1245 | 1245 |
|
| 1246 |
- PUT /containers/8cce319429b2/archive?path=/vol1 HTTP/1.1 |
|
| 1247 |
- Content-Type: application/x-tar |
|
| 1246 |
+ PUT /containers/8cce319429b2/archive?path=/vol1 HTTP/1.1 |
|
| 1247 |
+ Content-Type: application/x-tar |
|
| 1248 | 1248 |
|
| 1249 |
- {{ TAR STREAM }}
|
|
| 1249 |
+ {{ TAR STREAM }}
|
|
| 1250 | 1250 |
|
| 1251 | 1251 |
**Example response**: |
| 1252 | 1252 |
|
| 1253 |
- HTTP/1.1 200 OK |
|
| 1253 |
+ HTTP/1.1 200 OK |
|
| 1254 | 1254 |
|
| 1255 | 1255 |
Status Codes: |
| 1256 | 1256 |
|
| ... | ... |
@@ -1482,12 +1492,15 @@ a base64-encoded AuthConfig object. |
| 1482 | 1482 |
|
| 1483 | 1483 |
Query Parameters: |
| 1484 | 1484 |
|
| 1485 |
-- **fromImage** – Name of the image to pull. |
|
| 1485 |
+- **fromImage** – Name of the image to pull. The name may include a tag or |
|
| 1486 |
+ digest. This parameter may only be used when pulling an image. |
|
| 1486 | 1487 |
- **fromSrc** – Source to import. The value may be a URL from which the image |
| 1487 | 1488 |
can be retrieved or `-` to read the image from the request body. |
| 1488 |
-- **repo** – Repository name. |
|
| 1489 |
-- **tag** – Tag. |
|
| 1490 |
-- **registry** – The registry to pull from. |
|
| 1489 |
+ This parameter may only be used when importing an image. |
|
| 1490 |
+- **repo** – Repository name given to an image when it is imported. |
|
| 1491 |
+ The repo may include a tag. This parameter may only be used when importing |
|
| 1492 |
+ an image. |
|
| 1493 |
+- **tag** – Tag or digest. |
|
| 1491 | 1494 |
|
| 1492 | 1495 |
Request Headers: |
| 1493 | 1496 |
|
| ... | ... |
@@ -2380,29 +2393,37 @@ Return low-level information about the `exec` command `id`. |
| 2380 | 2380 |
"SecurityOpt" : null |
| 2381 | 2381 |
}, |
| 2382 | 2382 |
"Image" : "5506de2b643be1e6febbf3b8a240760c6843244c41e12aa2f60ccbb7153d17f5", |
| 2383 |
- "NetworkSettings": {
|
|
| 2384 |
- "Bridge": "", |
|
| 2385 |
- "SandboxID": "", |
|
| 2386 |
- "HairpinMode": false, |
|
| 2387 |
- "LinkLocalIPv6Address": "", |
|
| 2388 |
- "LinkLocalIPv6PrefixLen": 0, |
|
| 2389 |
- "SandboxKey": "", |
|
| 2390 |
- "SecondaryIPAddresses": [], |
|
| 2391 |
- "SecondaryIPv6Addresses": [], |
|
| 2392 |
- "Ports": null, |
|
| 2393 |
- "Networks": {
|
|
| 2394 |
- "bridge": {
|
|
| 2395 |
- "EndpointID": "", |
|
| 2396 |
- "Gateway": "", |
|
| 2397 |
- "IPAdress": "", |
|
| 2398 |
- "IPPrefixLen": 0, |
|
| 2399 |
- "IPv6Gateway": "", |
|
| 2400 |
- "GlobalIPv6Address": "", |
|
| 2401 |
- "GlobalIPv6PrefixLen": 0, |
|
| 2402 |
- "MacAddress": "" |
|
| 2403 |
- } |
|
| 2404 |
- } |
|
| 2405 |
- }, |
|
| 2383 |
+ "NetworkSettings": {
|
|
| 2384 |
+ "Bridge": "", |
|
| 2385 |
+ "SandboxID": "", |
|
| 2386 |
+ "HairpinMode": false, |
|
| 2387 |
+ "LinkLocalIPv6Address": "", |
|
| 2388 |
+ "LinkLocalIPv6PrefixLen": 0, |
|
| 2389 |
+ "Ports": null, |
|
| 2390 |
+ "SandboxKey": "", |
|
| 2391 |
+ "SecondaryIPAddresses": null, |
|
| 2392 |
+ "SecondaryIPv6Addresses": null, |
|
| 2393 |
+ "EndpointID": "", |
|
| 2394 |
+ "Gateway": "", |
|
| 2395 |
+ "GlobalIPv6Address": "", |
|
| 2396 |
+ "GlobalIPv6PrefixLen": 0, |
|
| 2397 |
+ "IPAddress": "", |
|
| 2398 |
+ "IPPrefixLen": 0, |
|
| 2399 |
+ "IPv6Gateway": "", |
|
| 2400 |
+ "MacAddress": "", |
|
| 2401 |
+ "Networks": {
|
|
| 2402 |
+ "bridge": {
|
|
| 2403 |
+ "EndpointID": "", |
|
| 2404 |
+ "Gateway": "", |
|
| 2405 |
+ "IPAddress": "", |
|
| 2406 |
+ "IPPrefixLen": 0, |
|
| 2407 |
+ "IPv6Gateway": "", |
|
| 2408 |
+ "GlobalIPv6Address": "", |
|
| 2409 |
+ "GlobalIPv6PrefixLen": 0, |
|
| 2410 |
+ "MacAddress": "" |
|
| 2411 |
+ } |
|
| 2412 |
+ } |
|
| 2413 |
+ }, |
|
| 2406 | 2414 |
"ResolvConfPath" : "/var/lib/docker/containers/8f177a186b977fb451136e0fdf182abff5599a08b3c7f6ef0d36a55aaf89634c/resolv.conf", |
| 2407 | 2415 |
"HostnamePath" : "/var/lib/docker/containers/8f177a186b977fb451136e0fdf182abff5599a08b3c7f6ef0d36a55aaf89634c/hostname", |
| 2408 | 2416 |
"HostsPath" : "/var/lib/docker/containers/8f177a186b977fb451136e0fdf182abff5599a08b3c7f6ef0d36a55aaf89634c/hosts", |
| ... | ... |
@@ -2432,26 +2453,26 @@ Status Codes: |
| 2432 | 2432 |
|
| 2433 | 2433 |
**Example request**: |
| 2434 | 2434 |
|
| 2435 |
- GET /volumes HTTP/1.1 |
|
| 2435 |
+ GET /volumes HTTP/1.1 |
|
| 2436 | 2436 |
|
| 2437 | 2437 |
**Example response**: |
| 2438 | 2438 |
|
| 2439 |
- HTTP/1.1 200 OK |
|
| 2440 |
- Content-Type: application/json |
|
| 2439 |
+ HTTP/1.1 200 OK |
|
| 2440 |
+ Content-Type: application/json |
|
| 2441 | 2441 |
|
| 2442 |
- {
|
|
| 2443 |
- "Volumes": [ |
|
| 2444 |
- {
|
|
| 2445 |
- "Name": "tardis", |
|
| 2446 |
- "Driver": "local", |
|
| 2447 |
- "Mountpoint": "/var/lib/docker/volumes/tardis" |
|
| 2448 |
- } |
|
| 2449 |
- ] |
|
| 2450 |
- } |
|
| 2442 |
+ {
|
|
| 2443 |
+ "Volumes": [ |
|
| 2444 |
+ {
|
|
| 2445 |
+ "Name": "tardis", |
|
| 2446 |
+ "Driver": "local", |
|
| 2447 |
+ "Mountpoint": "/var/lib/docker/volumes/tardis" |
|
| 2448 |
+ } |
|
| 2449 |
+ ] |
|
| 2450 |
+ } |
|
| 2451 | 2451 |
|
| 2452 | 2452 |
Query Parameters: |
| 2453 | 2453 |
|
| 2454 |
-- **filter** - JSON encoded value of the filters (a `map[string][]string`) to process on the volumes list. There is one available filter: `dangling=true` |
|
| 2454 |
+- **filters** - JSON encoded value of the filters (a `map[string][]string`) to process on the volumes list. There is one available filter: `dangling=true` |
|
| 2455 | 2455 |
|
| 2456 | 2456 |
Status Codes: |
| 2457 | 2457 |
|
| ... | ... |
@@ -2466,23 +2487,23 @@ Create a volume |
| 2466 | 2466 |
|
| 2467 | 2467 |
**Example request**: |
| 2468 | 2468 |
|
| 2469 |
- POST /volumes/create HTTP/1.1 |
|
| 2470 |
- Content-Type: application/json |
|
| 2469 |
+ POST /volumes/create HTTP/1.1 |
|
| 2470 |
+ Content-Type: application/json |
|
| 2471 | 2471 |
|
| 2472 |
- {
|
|
| 2473 |
- "Name": "tardis" |
|
| 2474 |
- } |
|
| 2472 |
+ {
|
|
| 2473 |
+ "Name": "tardis" |
|
| 2474 |
+ } |
|
| 2475 | 2475 |
|
| 2476 | 2476 |
**Example response**: |
| 2477 | 2477 |
|
| 2478 |
- HTTP/1.1 201 Created |
|
| 2479 |
- Content-Type: application/json |
|
| 2478 |
+ HTTP/1.1 201 Created |
|
| 2479 |
+ Content-Type: application/json |
|
| 2480 | 2480 |
|
| 2481 |
- {
|
|
| 2482 |
- "Name": "tardis" |
|
| 2483 |
- "Driver": "local", |
|
| 2484 |
- "Mountpoint": "/var/lib/docker/volumes/tardis" |
|
| 2485 |
- } |
|
| 2481 |
+ {
|
|
| 2482 |
+ "Name": "tardis", |
|
| 2483 |
+ "Driver": "local", |
|
| 2484 |
+ "Mountpoint": "/var/lib/docker/volumes/tardis" |
|
| 2485 |
+ } |
|
| 2486 | 2486 |
|
| 2487 | 2487 |
Status Codes: |
| 2488 | 2488 |
|
| ... | ... |
@@ -2508,14 +2529,14 @@ Return low-level information on the volume `name` |
| 2508 | 2508 |
|
| 2509 | 2509 |
**Example response**: |
| 2510 | 2510 |
|
| 2511 |
- HTTP/1.1 200 OK |
|
| 2512 |
- Content-Type: application/json |
|
| 2511 |
+ HTTP/1.1 200 OK |
|
| 2512 |
+ Content-Type: application/json |
|
| 2513 | 2513 |
|
| 2514 |
- {
|
|
| 2515 |
- "Name": "tardis", |
|
| 2516 |
- "Driver": "local", |
|
| 2517 |
- "Mountpoint": "/var/lib/docker/volumes/tardis" |
|
| 2518 |
- } |
|
| 2514 |
+ {
|
|
| 2515 |
+ "Name": "tardis", |
|
| 2516 |
+ "Driver": "local", |
|
| 2517 |
+ "Mountpoint": "/var/lib/docker/volumes/tardis" |
|
| 2518 |
+ } |
|
| 2519 | 2519 |
|
| 2520 | 2520 |
Status Codes: |
| 2521 | 2521 |
|
| ... | ... |
@@ -2531,11 +2552,11 @@ Instruct the driver to remove the volume (`name`). |
| 2531 | 2531 |
|
| 2532 | 2532 |
**Example request**: |
| 2533 | 2533 |
|
| 2534 |
- DELETE /volumes/local/tardis HTTP/1.1 |
|
| 2534 |
+ DELETE /volumes/local/tardis HTTP/1.1 |
|
| 2535 | 2535 |
|
| 2536 | 2536 |
**Example response**: |
| 2537 | 2537 |
|
| 2538 |
- HTTP/1.1 204 No Content |
|
| 2538 |
+ HTTP/1.1 204 No Content |
|
| 2539 | 2539 |
|
| 2540 | 2540 |
Status Codes |
| 2541 | 2541 |
|
| ... | ... |
@@ -2552,41 +2573,77 @@ Status Codes |
| 2552 | 2552 |
|
| 2553 | 2553 |
**Example request**: |
| 2554 | 2554 |
|
| 2555 |
- GET /networks HTTP/1.1 |
|
| 2555 |
+ GET /networks HTTP/1.1 |
|
| 2556 | 2556 |
|
| 2557 | 2557 |
**Example response**: |
| 2558 | 2558 |
|
| 2559 |
- HTTP/1.1 200 OK |
|
| 2560 |
- Content-Type: application/json |
|
| 2561 |
- |
|
| 2562 | 2559 |
``` |
| 2563 |
- [ |
|
| 2564 |
- {
|
|
| 2565 |
- "name": "bridge", |
|
| 2566 |
- "id": "f995e41e471c833266786a64df584fbe4dc654ac99f63a4ee7495842aa093fc4", |
|
| 2567 |
- "driver": "bridge", |
|
| 2568 |
- "containers": {}
|
|
| 2560 |
+HTTP/1.1 200 OK |
|
| 2561 |
+Content-Type: application/json |
|
| 2562 |
+ |
|
| 2563 |
+[ |
|
| 2564 |
+ {
|
|
| 2565 |
+ "Name": "bridge", |
|
| 2566 |
+ "Id": "f2de39df4171b0dc801e8002d1d999b77256983dfc63041c0f34030aa3977566", |
|
| 2567 |
+ "Scope": "local", |
|
| 2568 |
+ "Driver": "bridge", |
|
| 2569 |
+ "IPAM": {
|
|
| 2570 |
+ "Driver": "default", |
|
| 2571 |
+ "Config": [ |
|
| 2572 |
+ {
|
|
| 2573 |
+ "Subnet": "172.17.0.0/16" |
|
| 2574 |
+ } |
|
| 2575 |
+ ] |
|
| 2569 | 2576 |
}, |
| 2570 |
- {
|
|
| 2571 |
- "name": "none", |
|
| 2572 |
- "id": "21e34df9b29c74ae45ba312f8e9f83c02433c9a877cfebebcf57be78f69b77c8", |
|
| 2573 |
- "driver": "null", |
|
| 2574 |
- "containers": {}
|
|
| 2577 |
+ "Containers": {
|
|
| 2578 |
+ "39b69226f9d79f5634485fb236a23b2fe4e96a0a94128390a7fbbcc167065867": {
|
|
| 2579 |
+ "EndpointID": "ed2419a97c1d9954d05b46e462e7002ea552f216e9b136b80a7db8d98b442eda", |
|
| 2580 |
+ "MacAddress": "02:42:ac:11:00:02", |
|
| 2581 |
+ "IPv4Address": "172.17.0.2/16", |
|
| 2582 |
+ "IPv6Address": "" |
|
| 2583 |
+ } |
|
| 2575 | 2584 |
}, |
| 2576 |
- {
|
|
| 2577 |
- "name": "host", |
|
| 2578 |
- "id": "3f43a0873f00310a71cd6a71e2e60c113cf17d1812be2ec22fd519fbac68ec91", |
|
| 2579 |
- "driver": "host", |
|
| 2580 |
- "containers": {}
|
|
| 2585 |
+ "Options": {
|
|
| 2586 |
+ "com.docker.network.bridge.default_bridge": "true", |
|
| 2587 |
+ "com.docker.network.bridge.enable_icc": "true", |
|
| 2588 |
+ "com.docker.network.bridge.enable_ip_masquerade": "true", |
|
| 2589 |
+ "com.docker.network.bridge.host_binding_ipv4": "0.0.0.0", |
|
| 2590 |
+ "com.docker.network.bridge.name": "docker0", |
|
| 2591 |
+ "com.docker.network.driver.mtu": "1500" |
|
| 2581 | 2592 |
} |
| 2582 |
- ] |
|
| 2593 |
+ }, |
|
| 2594 |
+ {
|
|
| 2595 |
+ "Name": "none", |
|
| 2596 |
+ "Id": "e086a3893b05ab69242d3c44e49483a3bbbd3a26b46baa8f61ab797c1088d794", |
|
| 2597 |
+ "Scope": "local", |
|
| 2598 |
+ "Driver": "null", |
|
| 2599 |
+ "IPAM": {
|
|
| 2600 |
+ "Driver": "default", |
|
| 2601 |
+ "Config": [] |
|
| 2602 |
+ }, |
|
| 2603 |
+ "Containers": {},
|
|
| 2604 |
+ "Options": {}
|
|
| 2605 |
+ }, |
|
| 2606 |
+ {
|
|
| 2607 |
+ "Name": "host", |
|
| 2608 |
+ "Id": "13e871235c677f196c4e1ecebb9dc733b9b2d2ab589e30c539efeda84a24215e", |
|
| 2609 |
+ "Scope": "local", |
|
| 2610 |
+ "Driver": "host", |
|
| 2611 |
+ "IPAM": {
|
|
| 2612 |
+ "Driver": "default", |
|
| 2613 |
+ "Config": [] |
|
| 2614 |
+ }, |
|
| 2615 |
+ "Containers": {},
|
|
| 2616 |
+ "Options": {}
|
|
| 2617 |
+ } |
|
| 2618 |
+] |
|
| 2583 | 2619 |
``` |
| 2584 | 2620 |
|
| 2585 | 2621 |
|
| 2586 | 2622 |
|
| 2587 | 2623 |
Query Parameters: |
| 2588 | 2624 |
|
| 2589 |
-- **filter** - JSON encoded value of the filters (a `map[string][]string`) to process on the volumes list. Available filters: `name=[network-names]` , `id=[network-ids]` |
|
| 2625 |
+- **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]` |
|
| 2590 | 2626 |
|
| 2591 | 2627 |
Status Codes: |
| 2592 | 2628 |
|
| ... | ... |
@@ -2599,39 +2656,44 @@ Status Codes: |
| 2599 | 2599 |
|
| 2600 | 2600 |
**Example request**: |
| 2601 | 2601 |
|
| 2602 |
- GET /networks/f995e41e471c833266786a64df584fbe4dc654ac99f63a4ee7495842aa093fc4 HTTP/1.1 |
|
| 2602 |
+ GET /networks/f2de39df4171b0dc801e8002d1d999b77256983dfc63041c0f34030aa3977566 HTTP/1.1 |
|
| 2603 | 2603 |
|
| 2604 | 2604 |
**Example response**: |
| 2605 | 2605 |
|
| 2606 |
- HTTP/1.1 200 OK |
|
| 2607 |
- Content-Type: application/json |
|
| 2608 |
- |
|
| 2609 | 2606 |
``` |
| 2610 |
- {
|
|
| 2611 |
- "name": "bridge", |
|
| 2612 |
- "id": "f995e41e471c833266786a64df584fbe4dc654ac99f63a4ee7495842aa093fc4", |
|
| 2613 |
- "driver": "bridge", |
|
| 2614 |
- "containers": {
|
|
| 2615 |
- "931d29e96e63022a3691f55ca18b28600239acf53878451975f77054b05ba559": {
|
|
| 2616 |
- "endpoint": "aa79321e2899e6d72fcd46e6a4ad7f81ab9a19c3b06e384ef4ce51fea35827f9", |
|
| 2617 |
- "mac_address": "02:42:ac:11:00:04", |
|
| 2618 |
- "ipv4_address": "172.17.0.4/16", |
|
| 2619 |
- "ipv6_address": "" |
|
| 2620 |
- }, |
|
| 2621 |
- "961249b4ae6c764b11eed923e8463c102689111fffd933627b2e7e359c7d0f7c": {
|
|
| 2622 |
- "endpoint": "4f62c5aea6b9a70512210be7db976bd4ec2cdba47125e4fe514d18c81b1624b1", |
|
| 2623 |
- "mac_address": "02:42:ac:11:00:02", |
|
| 2624 |
- "ipv4_address": "172.17.0.2/16", |
|
| 2625 |
- "ipv6_address": "" |
|
| 2626 |
- }, |
|
| 2627 |
- "9f6e0fec4449f42a173ed85be96dc2253b6719edd850d8169bc31bdc45db675c": {
|
|
| 2628 |
- "endpoint": "352b512a5bccdfc77d16c2c04d04408e718f879a16f9ce3913a4733139e4f98d", |
|
| 2629 |
- "mac_address": "02:42:ac:11:00:03", |
|
| 2630 |
- "ipv4_address": "172.17.0.3/16", |
|
| 2631 |
- "ipv6_address": "" |
|
| 2607 |
+HTTP/1.1 200 OK |
|
| 2608 |
+Content-Type: application/json |
|
| 2609 |
+ |
|
| 2610 |
+{
|
|
| 2611 |
+ "Name": "bridge", |
|
| 2612 |
+ "Id": "f2de39df4171b0dc801e8002d1d999b77256983dfc63041c0f34030aa3977566", |
|
| 2613 |
+ "Scope": "local", |
|
| 2614 |
+ "Driver": "bridge", |
|
| 2615 |
+ "IPAM": {
|
|
| 2616 |
+ "Driver": "default", |
|
| 2617 |
+ "Config": [ |
|
| 2618 |
+ {
|
|
| 2619 |
+ "Subnet": "172.17.0.0/16" |
|
| 2632 | 2620 |
} |
| 2621 |
+ ] |
|
| 2622 |
+ }, |
|
| 2623 |
+ "Containers": {
|
|
| 2624 |
+ "39b69226f9d79f5634485fb236a23b2fe4e96a0a94128390a7fbbcc167065867": {
|
|
| 2625 |
+ "EndpointID": "ed2419a97c1d9954d05b46e462e7002ea552f216e9b136b80a7db8d98b442eda", |
|
| 2626 |
+ "MacAddress": "02:42:ac:11:00:02", |
|
| 2627 |
+ "IPv4Address": "172.17.0.2/16", |
|
| 2628 |
+ "IPv6Address": "" |
|
| 2633 | 2629 |
} |
| 2630 |
+ }, |
|
| 2631 |
+ "Options": {
|
|
| 2632 |
+ "com.docker.network.bridge.default_bridge": "true", |
|
| 2633 |
+ "com.docker.network.bridge.enable_icc": "true", |
|
| 2634 |
+ "com.docker.network.bridge.enable_ip_masquerade": "true", |
|
| 2635 |
+ "com.docker.network.bridge.host_binding_ipv4": "0.0.0.0", |
|
| 2636 |
+ "com.docker.network.bridge.name": "docker0", |
|
| 2637 |
+ "com.docker.network.driver.mtu": "1500" |
|
| 2634 | 2638 |
} |
| 2639 |
+} |
|
| 2635 | 2640 |
``` |
| 2636 | 2641 |
|
| 2637 | 2642 |
Status Codes: |
| ... | ... |
@@ -2647,26 +2709,26 @@ Create a network |
| 2647 | 2647 |
|
| 2648 | 2648 |
**Example request**: |
| 2649 | 2649 |
|
| 2650 |
- POST /networks/create HTTP/1.1 |
|
| 2651 |
- Content-Type: application/json |
|
| 2652 |
- |
|
| 2653 | 2650 |
``` |
| 2654 |
- {
|
|
| 2655 |
- "name":"isolated_nw", |
|
| 2656 |
- "driver":"bridge" |
|
| 2657 |
- } |
|
| 2651 |
+POST /networks/create HTTP/1.1 |
|
| 2652 |
+Content-Type: application/json |
|
| 2653 |
+ |
|
| 2654 |
+{
|
|
| 2655 |
+ "Name":"isolated_nw", |
|
| 2656 |
+ "Driver":"bridge" |
|
| 2657 |
+} |
|
| 2658 | 2658 |
``` |
| 2659 | 2659 |
|
| 2660 | 2660 |
**Example response**: |
| 2661 | 2661 |
|
| 2662 |
- HTTP/1.1 201 Created |
|
| 2663 |
- Content-Type: application/json |
|
| 2664 |
- |
|
| 2665 | 2662 |
``` |
| 2666 |
- {
|
|
| 2667 |
- "id": "22be93d5babb089c5aab8dbc369042fad48ff791584ca2da2100db837a1c7c30", |
|
| 2668 |
- "warning": "" |
|
| 2669 |
- } |
|
| 2663 |
+HTTP/1.1 201 Created |
|
| 2664 |
+Content-Type: application/json |
|
| 2665 |
+ |
|
| 2666 |
+{
|
|
| 2667 |
+ "Id": "22be93d5babb089c5aab8dbc369042fad48ff791584ca2da2100db837a1c7c30", |
|
| 2668 |
+ "Warning": "" |
|
| 2669 |
+} |
|
| 2670 | 2670 |
``` |
| 2671 | 2671 |
|
| 2672 | 2672 |
Status Codes: |
| ... | ... |
@@ -2677,10 +2739,10 @@ Status Codes: |
| 2677 | 2677 |
|
| 2678 | 2678 |
JSON Parameters: |
| 2679 | 2679 |
|
| 2680 |
-- **name** - The new network's name. this is a mandatory field |
|
| 2681 |
-- **driver** - Name of the network driver to use. Defaults to `bridge` driver |
|
| 2682 |
-- **options** - Network specific options to be used by the drivers |
|
| 2683 |
-- **check_duplicate** - Requests daemon to check for networks with same name |
|
| 2680 |
+- **Name** - The new network's name. this is a mandatory field |
|
| 2681 |
+- **Driver** - Name of the network driver to use. Defaults to `bridge` driver |
|
| 2682 |
+- **Options** - Network specific options to be used by the drivers |
|
| 2683 |
+- **CheckDuplicate** - Requests daemon to check for networks with same name |
|
| 2684 | 2684 |
|
| 2685 | 2685 |
### Connect a container to a network |
| 2686 | 2686 |
|
| ... | ... |
@@ -2690,18 +2752,18 @@ Connects a container to a network |
| 2690 | 2690 |
|
| 2691 | 2691 |
**Example request**: |
| 2692 | 2692 |
|
| 2693 |
- POST /networks/22be93d5babb089c5aab8dbc369042fad48ff791584ca2da2100db837a1c7c30/connect HTTP/1.1 |
|
| 2694 |
- Content-Type: application/json |
|
| 2695 |
- |
|
| 2696 | 2693 |
``` |
| 2697 |
- {
|
|
| 2698 |
- "container":"3613f73ba0e4" |
|
| 2699 |
- } |
|
| 2694 |
+POST /networks/22be93d5babb089c5aab8dbc369042fad48ff791584ca2da2100db837a1c7c30/connect HTTP/1.1 |
|
| 2695 |
+Content-Type: application/json |
|
| 2696 |
+ |
|
| 2697 |
+{
|
|
| 2698 |
+ "Container":"3613f73ba0e4" |
|
| 2699 |
+} |
|
| 2700 | 2700 |
``` |
| 2701 | 2701 |
|
| 2702 | 2702 |
**Example response**: |
| 2703 | 2703 |
|
| 2704 |
- HTTP/1.1 200 OK |
|
| 2704 |
+ HTTP/1.1 200 OK |
|
| 2705 | 2705 |
|
| 2706 | 2706 |
Status Codes: |
| 2707 | 2707 |
|
| ... | ... |
@@ -2720,18 +2782,18 @@ Disconnects a container from a network |
| 2720 | 2720 |
|
| 2721 | 2721 |
**Example request**: |
| 2722 | 2722 |
|
| 2723 |
- POST /networks/22be93d5babb089c5aab8dbc369042fad48ff791584ca2da2100db837a1c7c30/disconnect HTTP/1.1 |
|
| 2724 |
- Content-Type: application/json |
|
| 2725 |
- |
|
| 2726 | 2723 |
``` |
| 2727 |
- {
|
|
| 2728 |
- "container":"3613f73ba0e4" |
|
| 2729 |
- } |
|
| 2724 |
+POST /networks/22be93d5babb089c5aab8dbc369042fad48ff791584ca2da2100db837a1c7c30/disconnect HTTP/1.1 |
|
| 2725 |
+Content-Type: application/json |
|
| 2726 |
+ |
|
| 2727 |
+{
|
|
| 2728 |
+ "Container":"3613f73ba0e4" |
|
| 2729 |
+} |
|
| 2730 | 2730 |
``` |
| 2731 | 2731 |
|
| 2732 | 2732 |
**Example response**: |
| 2733 | 2733 |
|
| 2734 |
- HTTP/1.1 200 OK |
|
| 2734 |
+ HTTP/1.1 200 OK |
|
| 2735 | 2735 |
|
| 2736 | 2736 |
Status Codes: |
| 2737 | 2737 |
|
| ... | ... |
@@ -2740,7 +2802,7 @@ Status Codes: |
| 2740 | 2740 |
|
| 2741 | 2741 |
JSON Parameters: |
| 2742 | 2742 |
|
| 2743 |
-- **container** - container-id/name to be disconnected from a network |
|
| 2743 |
+- **Container** - container-id/name to be disconnected from a network |
|
| 2744 | 2744 |
|
| 2745 | 2745 |
### Remove a network |
| 2746 | 2746 |
|
| ... | ... |
@@ -2750,11 +2812,11 @@ Instruct the driver to remove the network (`id`). |
| 2750 | 2750 |
|
| 2751 | 2751 |
**Example request**: |
| 2752 | 2752 |
|
| 2753 |
- DELETE /networks/22be93d5babb089c5aab8dbc369042fad48ff791584ca2da2100db837a1c7c30 HTTP/1.1 |
|
| 2753 |
+ DELETE /networks/22be93d5babb089c5aab8dbc369042fad48ff791584ca2da2100db837a1c7c30 HTTP/1.1 |
|
| 2754 | 2754 |
|
| 2755 | 2755 |
**Example response**: |
| 2756 | 2756 |
|
| 2757 |
- HTTP/1.1 204 No Content |
|
| 2757 |
+ HTTP/1.1 204 No Content |
|
| 2758 | 2758 |
|
| 2759 | 2759 |
Status Codes |
| 2760 | 2760 |
|