|
@@ -187,7 +187,7 @@ List containers
|
|
|
}
|
|
|
]
|
|
|
|
|
|
-Query Parameters:
|
|
|
+**Query parameters**:
|
|
|
|
|
|
- **all** – 1/True/true or 0/False/false, Show all containers.
|
|
|
Only running containers are shown by default (i.e., this defaults to false)
|
|
@@ -205,7 +205,7 @@ Query Parameters:
|
|
|
- `label=key` or `label="key=value"` of a container label
|
|
|
- `isolation=`(`default`|`process`|`hyperv`) (Windows daemon only)
|
|
|
|
|
|
-Status Codes:
|
|
|
+**Status codes**:
|
|
|
|
|
|
- **200** – no error
|
|
|
- **400** – bad parameter
|
|
@@ -324,7 +324,7 @@ Create a container
|
|
|
"Warnings":[]
|
|
|
}
|
|
|
|
|
|
-Json Parameters:
|
|
|
+**JSON parameters**:
|
|
|
|
|
|
- **Hostname** - A string value containing the hostname to use for the
|
|
|
container.
|
|
@@ -435,12 +435,12 @@ Json Parameters:
|
|
|
- **VolumeDriver** - Driver that this container users to mount volumes.
|
|
|
- **ShmSize** - Size of `/dev/shm` in bytes. The size must be greater than 0. If omitted the system uses 64MB.
|
|
|
|
|
|
-Query Parameters:
|
|
|
+**Query parameters**:
|
|
|
|
|
|
- **name** – Assign the specified name to the container. Must
|
|
|
match `/?[a-zA-Z0-9_-]+`.
|
|
|
|
|
|
-Status Codes:
|
|
|
+**Status codes**:
|
|
|
|
|
|
- **201** – no error
|
|
|
- **400** – bad parameter
|
|
@@ -455,7 +455,6 @@ Status Codes:
|
|
|
|
|
|
Return low-level information on the container `id`
|
|
|
|
|
|
-
|
|
|
**Example request**:
|
|
|
|
|
|
GET /containers/4fa6e0f0c678/json HTTP/1.1
|
|
@@ -501,8 +500,8 @@ Return low-level information on the container `id`
|
|
|
"Tty": false,
|
|
|
"User": "",
|
|
|
"Volumes": {
|
|
|
- "/volumes/data": {}
|
|
|
- },
|
|
|
+ "/volumes/data": {}
|
|
|
+ },
|
|
|
"WorkingDir": "",
|
|
|
"StopSignal": "SIGTERM"
|
|
|
},
|
|
@@ -643,11 +642,11 @@ Return low-level information on the container `id`
|
|
|
....
|
|
|
}
|
|
|
|
|
|
-Query Parameters:
|
|
|
+**Query parameters**:
|
|
|
|
|
|
- **size** – 1/True/true or 0/False/false, return container size information. Default is `false`.
|
|
|
|
|
|
-Status Codes:
|
|
|
+**Status codes**:
|
|
|
|
|
|
- **200** – no error
|
|
|
- **404** – no such container
|
|
@@ -707,11 +706,11 @@ supported on Windows.
|
|
|
],
|
|
|
}
|
|
|
|
|
|
-Query Parameters:
|
|
|
+**Query parameters**:
|
|
|
|
|
|
- **ps_args** – `ps` arguments to use (e.g., `aux`), defaults to `-ef`
|
|
|
|
|
|
-Status Codes:
|
|
|
+**Status codes**:
|
|
|
|
|
|
- **200** – no error
|
|
|
- **404** – no such container
|
|
@@ -739,7 +738,7 @@ Get `stdout` and `stderr` logs from the container ``id``
|
|
|
|
|
|
{{ STREAM }}
|
|
|
|
|
|
-Query Parameters:
|
|
|
+**Query parameters**:
|
|
|
|
|
|
- **follow** – 1/True/true or 0/False/false, return stream. Default `false`.
|
|
|
- **stdout** – 1/True/true or 0/False/false, show `stdout` log. Default `false`.
|
|
@@ -750,7 +749,7 @@ Query Parameters:
|
|
|
every log line. Default `false`.
|
|
|
- **tail** – Output specified number of lines at the end of logs: `all` or `<number>`. Default all.
|
|
|
|
|
|
-Status Codes:
|
|
|
+**Status codes**:
|
|
|
|
|
|
- **101** – no error, hints proxy about hijacking
|
|
|
- **200** – no error, no upgrade header found
|
|
@@ -793,7 +792,7 @@ Values for `Kind`:
|
|
|
- `1`: Add
|
|
|
- `2`: Delete
|
|
|
|
|
|
-Status Codes:
|
|
|
+**Status codes**:
|
|
|
|
|
|
- **200** – no error
|
|
|
- **404** – no such container
|
|
@@ -816,7 +815,7 @@ Export the contents of container `id`
|
|
|
|
|
|
{{ TAR STREAM }}
|
|
|
|
|
|
-Status Codes:
|
|
|
+**Status codes**:
|
|
|
|
|
|
- **200** – no error
|
|
|
- **404** – no such container
|
|
@@ -933,11 +932,11 @@ This endpoint returns a live stream of a container's resource usage statistics.
|
|
|
|
|
|
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.
|
|
|
|
|
|
-Query Parameters:
|
|
|
+**Query parameters**:
|
|
|
|
|
|
- **stream** – 1/True/true or 0/False/false, pull stats once then disconnect. Default `true`.
|
|
|
|
|
|
-Status Codes:
|
|
|
+**Status codes**:
|
|
|
|
|
|
- **200** – no error
|
|
|
- **404** – no such container
|
|
@@ -959,12 +958,12 @@ Resize the TTY for container with `id`. The unit is number of characters. You m
|
|
|
Content-Length: 0
|
|
|
Content-Type: text/plain; charset=utf-8
|
|
|
|
|
|
-Query Parameters:
|
|
|
+**Query parameters**:
|
|
|
|
|
|
- **h** – height of `tty` session
|
|
|
- **w** – width
|
|
|
|
|
|
-Status Codes:
|
|
|
+**Status codes**:
|
|
|
|
|
|
- **200** – no error
|
|
|
- **404** – No such container
|
|
@@ -988,13 +987,13 @@ Start the container `id`
|
|
|
|
|
|
HTTP/1.1 204 No Content
|
|
|
|
|
|
-Query Parameters:
|
|
|
+**Query parameters**:
|
|
|
|
|
|
- **detachKeys** – Override the key sequence for detaching a
|
|
|
container. Format is a single character `[a-Z]` or `ctrl-<value>`
|
|
|
where `<value>` is one of: `a-z`, `@`, `^`, `[`, `,` or `_`.
|
|
|
|
|
|
-Status Codes:
|
|
|
+**Status codes**:
|
|
|
|
|
|
- **204** – no error
|
|
|
- **304** – container already started
|
|
@@ -1015,11 +1014,11 @@ Stop the container `id`
|
|
|
|
|
|
HTTP/1.1 204 No Content
|
|
|
|
|
|
-Query Parameters:
|
|
|
+**Query parameters**:
|
|
|
|
|
|
- **t** – number of seconds to wait before killing the container
|
|
|
|
|
|
-Status Codes:
|
|
|
+**Status codes**:
|
|
|
|
|
|
- **204** – no error
|
|
|
- **304** – container already stopped
|
|
@@ -1040,11 +1039,11 @@ Restart the container `id`
|
|
|
|
|
|
HTTP/1.1 204 No Content
|
|
|
|
|
|
-Query Parameters:
|
|
|
+**Query parameters**:
|
|
|
|
|
|
- **t** – number of seconds to wait before killing the container
|
|
|
|
|
|
-Status Codes:
|
|
|
+**Status codes**:
|
|
|
|
|
|
- **204** – no error
|
|
|
- **404** – no such container
|
|
@@ -1064,12 +1063,12 @@ Kill the container `id`
|
|
|
|
|
|
HTTP/1.1 204 No Content
|
|
|
|
|
|
-Query Parameters
|
|
|
+**Query parameters**:
|
|
|
|
|
|
- **signal** - Signal to send to the container: integer or string like `SIGINT`.
|
|
|
When not set, `SIGKILL` is assumed and the call waits for the container to exit.
|
|
|
|
|
|
-Status Codes:
|
|
|
+**Status codes**:
|
|
|
|
|
|
- **204** – no error
|
|
|
- **404** – no such container
|
|
@@ -1108,7 +1107,7 @@ Update resource configs of one or more containers.
|
|
|
"Warnings": []
|
|
|
}
|
|
|
|
|
|
-Status Codes:
|
|
|
+**Status codes**:
|
|
|
|
|
|
- **200** – no error
|
|
|
- **400** – bad parameter
|
|
@@ -1129,11 +1128,11 @@ Rename the container `id` to a `new_name`
|
|
|
|
|
|
HTTP/1.1 204 No Content
|
|
|
|
|
|
-Query Parameters:
|
|
|
+**Query parameters**:
|
|
|
|
|
|
- **name** – new name for the container
|
|
|
|
|
|
-Status Codes:
|
|
|
+**Status codes**:
|
|
|
|
|
|
- **204** – no error
|
|
|
- **404** – no such container
|
|
@@ -1154,7 +1153,7 @@ Pause the container `id`
|
|
|
|
|
|
HTTP/1.1 204 No Content
|
|
|
|
|
|
-Status Codes:
|
|
|
+**Status codes**:
|
|
|
|
|
|
- **204** – no error
|
|
|
- **404** – no such container
|
|
@@ -1174,7 +1173,7 @@ Unpause the container `id`
|
|
|
|
|
|
HTTP/1.1 204 No Content
|
|
|
|
|
|
-Status Codes:
|
|
|
+**Status codes**:
|
|
|
|
|
|
- **204** – no error
|
|
|
- **404** – no such container
|
|
@@ -1199,7 +1198,7 @@ Attach to the container `id`
|
|
|
|
|
|
{{ STREAM }}
|
|
|
|
|
|
-Query Parameters:
|
|
|
+**Query parameters**:
|
|
|
|
|
|
- **detachKeys** – Override the key sequence for detaching a
|
|
|
container. Format is a single character `[a-Z]` or `ctrl-<value>`
|
|
@@ -1214,7 +1213,7 @@ Query Parameters:
|
|
|
- **stderr** – 1/True/true or 0/False/false, if `logs=true`, return
|
|
|
`stderr` log, if `stream=true`, attach to `stderr`. Default `false`.
|
|
|
|
|
|
-Status Codes:
|
|
|
+**Status codes**:
|
|
|
|
|
|
- **101** – no error, hints proxy about hijacking
|
|
|
- **200** – no error, no upgrade header found
|
|
@@ -1283,7 +1282,7 @@ Implements websocket protocol handshake according to [RFC 6455](http://tools.iet
|
|
|
|
|
|
{{ STREAM }}
|
|
|
|
|
|
-Query Parameters:
|
|
|
+**Query parameters**:
|
|
|
|
|
|
- **detachKeys** – Override the key sequence for detaching a
|
|
|
container. Format is a single character `[a-Z]` or `ctrl-<value>`
|
|
@@ -1298,7 +1297,7 @@ Query Parameters:
|
|
|
- **stderr** – 1/True/true or 0/False/false, if `logs=true`, return
|
|
|
`stderr` log, if `stream=true`, attach to `stderr`. Default `false`.
|
|
|
|
|
|
-Status Codes:
|
|
|
+**Status codes**:
|
|
|
|
|
|
- **200** – no error
|
|
|
- **400** – bad parameter
|
|
@@ -1322,7 +1321,7 @@ Block until container `id` stops, then returns the exit code
|
|
|
|
|
|
{"StatusCode": 0}
|
|
|
|
|
|
-Status Codes:
|
|
|
+**Status codes**:
|
|
|
|
|
|
- **200** – no error
|
|
|
- **404** – no such container
|
|
@@ -1342,14 +1341,14 @@ Remove the container `id` from the filesystem
|
|
|
|
|
|
HTTP/1.1 204 No Content
|
|
|
|
|
|
-Query Parameters:
|
|
|
+**Query parameters**:
|
|
|
|
|
|
- **v** – 1/True/true or 0/False/false, Remove the volumes
|
|
|
associated to the container. Default `false`.
|
|
|
- **force** - 1/True/true or 0/False/false, Kill then remove the container.
|
|
|
Default `false`.
|
|
|
|
|
|
-Status Codes:
|
|
|
+**Status codes**:
|
|
|
|
|
|
- **204** – no error
|
|
|
- **400** – bad parameter
|
|
@@ -1381,7 +1380,7 @@ Copy files or folders of container `id`
|
|
|
|
|
|
{{ TAR STREAM }}
|
|
|
|
|
|
-Status Codes:
|
|
|
+**Status codes**:
|
|
|
|
|
|
- **200** – no error
|
|
|
- **404** – no such container
|
|
@@ -1400,7 +1399,7 @@ following section.
|
|
|
|
|
|
Get a tar archive of a resource in the filesystem of container `id`.
|
|
|
|
|
|
-Query Parameters:
|
|
|
+**Query parameters**:
|
|
|
|
|
|
- **path** - resource in the container's filesystem to archive. Required.
|
|
|
|
|
@@ -1411,39 +1410,41 @@ Query Parameters:
|
|
|
indicates that only the contents of the **path** directory should be
|
|
|
copied. A symlink is always resolved to its target.
|
|
|
|
|
|
- **Note**: It is not possible to copy certain system files such as resources
|
|
|
- under `/proc`, `/sys`, `/dev`, and mounts created by the user in the
|
|
|
- container.
|
|
|
+ > **Note**: It is not possible to copy certain system files such as resources
|
|
|
+ > under `/proc`, `/sys`, `/dev`, and mounts created by the user in the
|
|
|
+ > container.
|
|
|
|
|
|
**Example request**:
|
|
|
|
|
|
- GET /containers/8cce319429b2/archive?path=/root HTTP/1.1
|
|
|
+ GET /containers/8cce319429b2/archive?path=/root HTTP/1.1
|
|
|
|
|
|
**Example response**:
|
|
|
|
|
|
- HTTP/1.1 200 OK
|
|
|
- Content-Type: application/x-tar
|
|
|
- X-Docker-Container-Path-Stat: eyJuYW1lIjoicm9vdCIsInNpemUiOjQwOTYsIm1vZGUiOjIxNDc0ODQwOTYsIm10aW1lIjoiMjAxNC0wMi0yN1QyMDo1MToyM1oiLCJsaW5rVGFyZ2V0IjoiIn0=
|
|
|
+ HTTP/1.1 200 OK
|
|
|
+ Content-Type: application/x-tar
|
|
|
+ X-Docker-Container-Path-Stat: eyJuYW1lIjoicm9vdCIsInNpemUiOjQwOTYsIm1vZGUiOjIxNDc0ODQwOTYsIm10aW1lIjoiMjAxNC0wMi0yN1QyMDo1MToyM1oiLCJsaW5rVGFyZ2V0IjoiIn0=
|
|
|
|
|
|
- {{ TAR STREAM }}
|
|
|
+ {{ TAR STREAM }}
|
|
|
|
|
|
On success, a response header `X-Docker-Container-Path-Stat` will be set to a
|
|
|
base64-encoded JSON object containing some filesystem header information about
|
|
|
the archived resource. The above example value would decode to the following
|
|
|
JSON object (whitespace added for readability):
|
|
|
|
|
|
- {
|
|
|
- "name": "root",
|
|
|
- "size": 4096,
|
|
|
- "mode": 2147484096,
|
|
|
- "mtime": "2014-02-27T20:51:23Z",
|
|
|
- "linkTarget": ""
|
|
|
- }
|
|
|
+```json
|
|
|
+{
|
|
|
+ "name": "root",
|
|
|
+ "size": 4096,
|
|
|
+ "mode": 2147484096,
|
|
|
+ "mtime": "2014-02-27T20:51:23Z",
|
|
|
+ "linkTarget": ""
|
|
|
+}
|
|
|
+```
|
|
|
|
|
|
A `HEAD` request can also be made to this endpoint if only this information is
|
|
|
desired.
|
|
|
|
|
|
-Status Codes:
|
|
|
+**Status codes**:
|
|
|
|
|
|
- **200** - success, returns archive of copied resource
|
|
|
- **400** - client error, bad parameter, details in JSON response body, one of:
|
|
@@ -1462,7 +1463,7 @@ Status Codes:
|
|
|
Upload a tar archive to be extracted to a path in the filesystem of container
|
|
|
`id`.
|
|
|
|
|
|
-Query Parameters:
|
|
|
+**Query parameters**:
|
|
|
|
|
|
- **path** - path to a directory in the container
|
|
|
to extract the archive's contents into. Required.
|
|
@@ -1484,7 +1485,7 @@ Query Parameters:
|
|
|
|
|
|
HTTP/1.1 200 OK
|
|
|
|
|
|
-Status Codes:
|
|
|
+**Status codes**:
|
|
|
|
|
|
- **200** – the content was extracted successfully
|
|
|
- **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:
|
|
|
See the `docker run` and `docker build` commands for examples of digest and tag
|
|
|
references on the command line.
|
|
|
|
|
|
-Query Parameters:
|
|
|
+**Query parameters**:
|
|
|
|
|
|
- **all** – 1/True/true or 0/False/false, default false
|
|
|
- **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)).
|
|
|
The build is canceled if the client drops the connection by quitting
|
|
|
or being killed.
|
|
|
|
|
|
-Query Parameters:
|
|
|
+**Query parameters**:
|
|
|
|
|
|
- **dockerfile** - Path within the build context to the Dockerfile. This is
|
|
|
ignored if `remote` is specified and points to an individual filename.
|
|
@@ -1639,7 +1640,7 @@ Query Parameters:
|
|
|
You can provide one or more `t` parameters.
|
|
|
- **remote** – A Git repository URI or HTTP/HTTPS URI build source. If the
|
|
|
URI specifies a filename, the file's contents are placed into a file
|
|
|
- called `Dockerfile`.
|
|
|
+ called `Dockerfile`.
|
|
|
- **q** – Suppress verbose build output.
|
|
|
- **nocache** – Do not use the cache when building the image.
|
|
|
- **pull** - Attempt to pull the image even if an older image exists locally.
|
|
@@ -1684,7 +1685,7 @@ Query Parameters:
|
|
|
be specified with both a "https://" prefix and a "/v1/" suffix even
|
|
|
though Docker will prefer to use the v2 registry API.
|
|
|
|
|
|
-Status Codes:
|
|
|
+**Status codes**:
|
|
|
|
|
|
- **200** – no error
|
|
|
- **500** – server error
|
|
@@ -1713,7 +1714,7 @@ When using this endpoint to pull an image from the registry, the
|
|
|
`X-Registry-Auth` header can be used to include
|
|
|
a base64-encoded AuthConfig object.
|
|
|
|
|
|
-Query Parameters:
|
|
|
+**Query parameters**:
|
|
|
|
|
|
- **fromImage** – Name of the image to pull. The name may include a tag or
|
|
|
digest. This parameter may only be used when pulling an image.
|
|
@@ -1747,7 +1748,7 @@ Query Parameters:
|
|
|
}
|
|
|
```
|
|
|
|
|
|
-Status Codes:
|
|
|
+**Status codes**:
|
|
|
|
|
|
- **200** – no error
|
|
|
- **500** – server error
|
|
@@ -1859,7 +1860,7 @@ Return low-level information on the image `name`
|
|
|
}
|
|
|
}
|
|
|
|
|
|
-Status Codes:
|
|
|
+**Status codes**:
|
|
|
|
|
|
- **200** – no error
|
|
|
- **404** – no such image
|
|
@@ -1913,7 +1914,7 @@ Return the history of the image `name`
|
|
|
}
|
|
|
]
|
|
|
|
|
|
-Status Codes:
|
|
|
+**Status codes**:
|
|
|
|
|
|
- **200** – no error
|
|
|
- **404** – no such image
|
|
@@ -1950,7 +1951,7 @@ The push is cancelled if the HTTP connection is closed.
|
|
|
POST /images/registry.acme.com:5000/test/push HTTP/1.1
|
|
|
|
|
|
|
|
|
-Query Parameters:
|
|
|
+**Query parameters**:
|
|
|
|
|
|
- **tag** – The tag to associate with the image on the registry. This is optional.
|
|
|
|
|
@@ -1975,7 +1976,7 @@ Request Headers:
|
|
|
}
|
|
|
```
|
|
|
|
|
|
-Status Codes:
|
|
|
+**Status codes**:
|
|
|
|
|
|
- **200** – no error
|
|
|
- **404** – no such image
|
|
@@ -1995,13 +1996,13 @@ Tag the image `name` into a repository
|
|
|
|
|
|
HTTP/1.1 201 Created
|
|
|
|
|
|
-Query Parameters:
|
|
|
+**Query parameters**:
|
|
|
|
|
|
- **repo** – The repository to tag in
|
|
|
- **force** – 1/True/true or 0/False/false, default false
|
|
|
- **tag** - The new tag name
|
|
|
|
|
|
-Status Codes:
|
|
|
+**Status codes**:
|
|
|
|
|
|
- **201** – no error
|
|
|
- **400** – bad parameter
|
|
@@ -2030,12 +2031,12 @@ Remove the image `name` from the filesystem
|
|
|
{"Deleted": "53b4f83ac9"}
|
|
|
]
|
|
|
|
|
|
-Query Parameters:
|
|
|
+**Query parameters**:
|
|
|
|
|
|
- **force** – 1/True/true or 0/False/false, default false
|
|
|
- **noprune** – 1/True/true or 0/False/false, default false
|
|
|
|
|
|
-Status Codes:
|
|
|
+**Status codes**:
|
|
|
|
|
|
- **200** – no error
|
|
|
- **404** – no such image
|
|
@@ -2086,11 +2087,11 @@ Search for an image on [Docker Hub](https://hub.docker.com).
|
|
|
...
|
|
|
]
|
|
|
|
|
|
-Query Parameters:
|
|
|
+**Query parameters**:
|
|
|
|
|
|
- **term** – term to search
|
|
|
|
|
|
-Status Codes:
|
|
|
+**Status codes**:
|
|
|
|
|
|
- **200** – no error
|
|
|
- **500** – server error
|
|
@@ -2119,7 +2120,7 @@ Get the default username and email
|
|
|
|
|
|
HTTP/1.1 200 OK
|
|
|
|
|
|
-Status Codes:
|
|
|
+**Status codes**:
|
|
|
|
|
|
- **200** – no error
|
|
|
- **204** – no error
|
|
@@ -2207,7 +2208,7 @@ Display system-wide information
|
|
|
"SystemTime": "2015-03-10T11:11:23.730591467-07:00"
|
|
|
}
|
|
|
|
|
|
-Status Codes:
|
|
|
+**Status codes**:
|
|
|
|
|
|
- **200** – no error
|
|
|
- **500** – server error
|
|
@@ -2239,7 +2240,7 @@ Show the docker version information
|
|
|
"Experimental": true
|
|
|
}
|
|
|
|
|
|
-Status Codes:
|
|
|
+**Status codes**:
|
|
|
|
|
|
- **200** – no error
|
|
|
- **500** – server error
|
|
@@ -2261,7 +2262,7 @@ Ping the docker server
|
|
|
|
|
|
OK
|
|
|
|
|
|
-Status Codes:
|
|
|
+**Status codes**:
|
|
|
|
|
|
- **200** - no error
|
|
|
- **500** - server error
|
|
@@ -2317,11 +2318,11 @@ Create a new image from a container's changes
|
|
|
|
|
|
{"Id": "596069db4bf5"}
|
|
|
|
|
|
-Json Parameters:
|
|
|
+**JSON parameters**:
|
|
|
|
|
|
- **config** - the container's configuration
|
|
|
|
|
|
-Query Parameters:
|
|
|
+**Query parameters**:
|
|
|
|
|
|
- **container** – source container
|
|
|
- **repo** – repository
|
|
@@ -2332,7 +2333,7 @@ Query Parameters:
|
|
|
- **pause** – 1/True/true or 0/False/false, whether to pause the container before committing
|
|
|
- **changes** – Dockerfile instructions to apply while committing
|
|
|
|
|
|
-Status Codes:
|
|
|
+**Status codes**:
|
|
|
|
|
|
- **201** – no error
|
|
|
- **404** – no such container
|
|
@@ -2520,7 +2521,7 @@ Docker networks report the following events:
|
|
|
"timeNano": 1461943105338056026
|
|
|
}
|
|
|
|
|
|
-Query Parameters:
|
|
|
+**Query parameters**:
|
|
|
|
|
|
- **since** – Timestamp used for polling
|
|
|
- **until** – Timestamp used for polling
|
|
@@ -2533,7 +2534,7 @@ Query Parameters:
|
|
|
- `volume=<string>`; -- volume to filter
|
|
|
- `network=<string>`; -- network to filter
|
|
|
|
|
|
-Status Codes:
|
|
|
+**Status codes**:
|
|
|
|
|
|
- **200** – no error
|
|
|
- **500** – server error
|
|
@@ -2563,12 +2564,12 @@ See the [image tarball format](#image-tarball-format) for more details.
|
|
|
|
|
|
Binary data stream
|
|
|
|
|
|
-Status Codes:
|
|
|
+**Status codes**:
|
|
|
|
|
|
- **200** – no error
|
|
|
- **500** – server error
|
|
|
|
|
|
-### Get a tarball containing all images.
|
|
|
+### Get a tarball containing all images
|
|
|
|
|
|
`GET /images/get`
|
|
|
|
|
@@ -2592,7 +2593,7 @@ See the [image tarball format](#image-tarball-format) for more details.
|
|
|
|
|
|
Binary data stream
|
|
|
|
|
|
-Status Codes:
|
|
|
+**Status codes**:
|
|
|
|
|
|
- **200** – no error
|
|
|
- **500** – server error
|
|
@@ -2614,7 +2615,7 @@ See the [image tarball format](#image-tarball-format) for more details.
|
|
|
|
|
|
HTTP/1.1 200 OK
|
|
|
|
|
|
-Status Codes:
|
|
|
+**Status codes**:
|
|
|
|
|
|
- **200** – no error
|
|
|
- **500** – server error
|
|
@@ -2672,7 +2673,7 @@ Sets up an exec instance in a running container `id`
|
|
|
"Warnings":[]
|
|
|
}
|
|
|
|
|
|
-Json Parameters:
|
|
|
+**JSON parameters**:
|
|
|
|
|
|
- **AttachStdin** - Boolean value, attaches to `stdin` of the `exec` command.
|
|
|
- **AttachStdout** - Boolean value, attaches to `stdout` of the `exec` command.
|
|
@@ -2684,7 +2685,7 @@ Json Parameters:
|
|
|
- **Cmd** - Command to run specified as a string or an array of strings.
|
|
|
|
|
|
|
|
|
-Status Codes:
|
|
|
+**Status codes**:
|
|
|
|
|
|
- **201** – no error
|
|
|
- **404** – no such container
|
|
@@ -2716,12 +2717,12 @@ interactive session with the `exec` command.
|
|
|
|
|
|
{{ STREAM }}
|
|
|
|
|
|
-Json Parameters:
|
|
|
+**JSON parameters**:
|
|
|
|
|
|
- **Detach** - Detach from the `exec` command.
|
|
|
- **Tty** - Boolean value to allocate a pseudo-TTY.
|
|
|
|
|
|
-Status Codes:
|
|
|
+**Status codes**:
|
|
|
|
|
|
- **200** – no error
|
|
|
- **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
|
|
|
HTTP/1.1 201 Created
|
|
|
Content-Type: text/plain
|
|
|
|
|
|
-Query Parameters:
|
|
|
+**Query parameters**:
|
|
|
|
|
|
- **h** – height of `tty` session
|
|
|
- **w** – width
|
|
|
|
|
|
-Status Codes:
|
|
|
+**Status codes**:
|
|
|
|
|
|
- **201** – no error
|
|
|
- **404** – no such exec instance
|
|
@@ -2794,7 +2795,7 @@ Return low-level information about the `exec` command `id`.
|
|
|
"Running": false
|
|
|
}
|
|
|
|
|
|
-Status Codes:
|
|
|
+**Status codes**:
|
|
|
|
|
|
- **200** – no error
|
|
|
- **404** – no such exec instance
|
|
@@ -2826,11 +2827,11 @@ Status Codes:
|
|
|
"Warnings": []
|
|
|
}
|
|
|
|
|
|
-Query Parameters:
|
|
|
+**Query parameters**:
|
|
|
|
|
|
- **filters** - JSON encoded value of the filters (a `map[string][]string`) to process on the volumes list. There is one available filter: `dangling=true`
|
|
|
|
|
|
-Status Codes:
|
|
|
+**Status codes**:
|
|
|
|
|
|
- **200** - no error
|
|
|
- **500** - server error
|
|
@@ -2861,12 +2862,12 @@ Create a volume
|
|
|
"Mountpoint": "/var/lib/docker/volumes/tardis"
|
|
|
}
|
|
|
|
|
|
-Status Codes:
|
|
|
+**Status codes**:
|
|
|
|
|
|
- **201** - no error
|
|
|
- **500** - server error
|
|
|
|
|
|
-JSON Parameters:
|
|
|
+**JSON parameters**:
|
|
|
|
|
|
- **Name** - The new volume's name. If not specified, Docker generates a name.
|
|
|
- **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`
|
|
|
"Mountpoint": "/var/lib/docker/volumes/tardis"
|
|
|
}
|
|
|
|
|
|
-Status Codes:
|
|
|
+**Status codes**:
|
|
|
|
|
|
- **200** - no error
|
|
|
- **404** - no such volume
|
|
@@ -2914,7 +2915,7 @@ Instruct the driver to remove the volume (`name`).
|
|
|
|
|
|
HTTP/1.1 204 No Content
|
|
|
|
|
|
-Status Codes
|
|
|
+**Status codes**:
|
|
|
|
|
|
- **204** - no error
|
|
|
- **404** - no such volume or volume driver
|
|
@@ -2995,14 +2996,14 @@ Content-Type: application/json
|
|
|
]
|
|
|
```
|
|
|
|
|
|
-Query Parameters:
|
|
|
+**Query parameters**:
|
|
|
|
|
|
- **filters** - JSON encoded network list filter. The filter value is one of:
|
|
|
- - `name=<network-name>` Matches all or part of a network name.
|
|
|
- `id=<network-id>` Matches all or part of a network id.
|
|
|
+ - `name=<network-name>` Matches all or part of a network name.
|
|
|
- `type=["custom"|"builtin"]` Filters networks by type. The `custom` keyword returns all user-defined networks.
|
|
|
|
|
|
-Status Codes:
|
|
|
+**Status codes**:
|
|
|
|
|
|
- **200** - no error
|
|
|
- **500** - server error
|
|
@@ -3058,7 +3059,7 @@ Content-Type: application/json
|
|
|
}
|
|
|
```
|
|
|
|
|
|
-Status Codes:
|
|
|
+**Status codes**:
|
|
|
|
|
|
- **200** - no error
|
|
|
- **404** - network not found
|
|
@@ -3110,13 +3111,13 @@ Content-Type: application/json
|
|
|
}
|
|
|
```
|
|
|
|
|
|
-Status Codes:
|
|
|
+**Status codes**:
|
|
|
|
|
|
- **201** - no error
|
|
|
- **404** - plugin not found
|
|
|
- **500** - server error
|
|
|
|
|
|
-JSON Parameters:
|
|
|
+**JSON parameters**:
|
|
|
|
|
|
- **Name** - The new network's name. this is a mandatory field
|
|
|
- **Driver** - Name of the network driver plugin to use. Defaults to `bridge` driver
|
|
@@ -3151,13 +3152,13 @@ Content-Type: application/json
|
|
|
|
|
|
HTTP/1.1 200 OK
|
|
|
|
|
|
-Status Codes:
|
|
|
+**Status codes**:
|
|
|
|
|
|
- **200** - no error
|
|
|
- **404** - network or container is not found
|
|
|
- **500** - Internal Server Error
|
|
|
|
|
|
-JSON Parameters:
|
|
|
+**JSON parameters**:
|
|
|
|
|
|
- **container** - container-id/name to be connected to the network
|
|
|
|
|
@@ -3183,13 +3184,13 @@ Content-Type: application/json
|
|
|
|
|
|
HTTP/1.1 200 OK
|
|
|
|
|
|
-Status Codes:
|
|
|
+**Status codes**:
|
|
|
|
|
|
- **200** - no error
|
|
|
- **404** - network or container not found
|
|
|
- **500** - Internal Server Error
|
|
|
|
|
|
-JSON Parameters:
|
|
|
+**JSON parameters**:
|
|
|
|
|
|
- **Container** - container-id/name to be disconnected from a network
|
|
|
- **Force** - Force the container to disconnect from a network
|
|
@@ -3208,7 +3209,7 @@ Instruct the driver to remove the network (`id`).
|
|
|
|
|
|
HTTP/1.1 200 OK
|
|
|
|
|
|
-Status Codes
|
|
|
+**Status codes**:
|
|
|
|
|
|
- **200** - no error
|
|
|
- **404** - no such network
|