github.com/jwhonce/docker@v0.6.7-0.20190327063223-da823cf3a5a3/docs/api/version-history.md (about) 1 --- 2 title: "Engine API version history" 3 description: "Documentation of changes that have been made to Engine API." 4 keywords: "API, Docker, rcli, REST, documentation" 5 --- 6 7 <!-- This file is maintained within the moby/moby GitHub 8 repository at https://github.com/moby/moby/. Make all 9 pull requests against that repo. If you see this file in 10 another repository, consider it read-only there, as it will 11 periodically be overwritten by the definitive file. Pull 12 requests which include edits to this file in other repositories 13 will be rejected. 14 --> 15 16 ## v1.40 API changes 17 18 [Docker Engine API v1.40](https://docs.docker.com/engine/api/v1.40/) documentation 19 20 * The `/_ping` endpoint can now be accessed both using `GET` or `HEAD` requests. 21 when accessed using a `HEAD` request, all headers are returned, but the body 22 is empty (`Content-Length: 0`). This change is not versioned, and affects all 23 API versions if the daemon has this patch. Clients are recommended to try 24 using `HEAD`, but fallback to `GET` if the `HEAD` requests fails. 25 * `GET /_ping` and `HEAD /_ping` now set `Cache-Control` and `Pragma` headers to 26 prevent the result from being cached. This change is not versioned, and affects 27 all API versions if the daemon has this patch. 28 * `GET /services` now returns `Sysctls` as part of the `ContainerSpec`. 29 * `GET /services/{id}` now returns `Sysctls` as part of the `ContainerSpec`. 30 * `POST /services/create` now accepts `Sysctls` as part of the `ContainerSpec`. 31 * `POST /services/{id}/update` now accepts `Sysctls` as part of the `ContainerSpec`. 32 * `POST /services/create` now accepts `Config` as part of `ContainerSpec.Privileges.CredentialSpec`. 33 * `POST /services/{id}/update` now accepts `Config` as part of `ContainerSpec.Privileges.CredentialSpec`. 34 * `POST /services/create` now includes `Runtime` as an option in `ContainerSpec.Configs` 35 * `POST /services/{id}/update` now includes `Runtime` as an option in `ContainerSpec.Configs` 36 * `GET /tasks` now returns `Sysctls` as part of the `ContainerSpec`. 37 * `GET /tasks/{id}` now returns `Sysctls` as part of the `ContainerSpec`. 38 * `GET /networks` now supports a `dangling` filter type. When set to `true` (or 39 `1`), the endpoint returns all networks that are not in use by a container. When 40 set to `false` (or `0`), only networks that are in use by one or more containers 41 are returned. 42 * `GET /nodes` now supports a filter type `node.label` filter to filter nodes based 43 on the node.label. The format of the label filter is `node.label=<key>`/`node.label=<key>=<value>` 44 to return those with the specified labels, or `node.label!=<key>`/`node.label!=<key>=<value>` 45 to return those without the specified labels. 46 * `POST /containers/create`, `GET /containers/{id}/json`, and `GET /containers/json` now supports 47 `BindOptions.NonRecursive`. 48 * `POST /swarm/init` now accepts a `DataPathPort` property to set data path port number. 49 * `GET /info` now returns information about `DataPathPort` that is currently used in swarm 50 * `GET /info` now returns `PidsLimit` boolean to indicate if the host kernel has 51 PID limit support enabled. 52 * `POST /containers/create` now accepts `DeviceRequests` as part of `HostConfig`. 53 Can be used to set Nvidia GPUs. 54 * `GET /swarm` endpoint now returns DataPathPort info 55 * `POST /containers/create` now takes `KernelMemoryTCP` field to set hard limit for kernel TCP buffer memory. 56 * `GET /service` now returns `MaxReplicas` as part of the `Placement`. 57 * `GET /service/{id}` now returns `MaxReplicas` as part of the `Placement`. 58 * `POST /service/create` and `POST /services/(id or name)/update` now take the field `MaxReplicas` 59 as part of the service `Placement`, allowing to specify maximum replicas per node for the service. 60 * `GET /containers` now returns `Capabilities` field as part of the `HostConfig`. 61 * `GET /containers/{id}/json` now returns a `Capabilities` field as part of the `HostConfig`. 62 * `POST /containers/create` now takes a `Capabilities` field to set the list of 63 kernel capabilities to be available for the container (this overrides the default 64 set). 65 * `POST /containers/create` on Linux now creates a container with `HostConfig.IpcMode=private` 66 by default, if IpcMode is not explicitly specified. The per-daemon default can be changed 67 back to `shareable` by using `DefaultIpcMode` daemon configuration parameter. 68 * `POST /containers/{id}/update` now accepts a `PidsLimit` field to tune a container's 69 PID limit. Set `0` or `-1` for unlimited. Leave `null` to not change the current value. 70 * `POST /build` now accepts `outputs` key for configuring build outputs when using BuildKit mode. 71 72 ## V1.39 API changes 73 74 [Docker Engine API v1.39](https://docs.docker.com/engine/api/v1.39/) documentation 75 76 * `GET /info` now returns an empty string, instead of `<unknown>` for `KernelVersion` 77 and `OperatingSystem` if the daemon was unable to obtain this information. 78 * `GET /info` now returns information about the product license, if a license 79 has been applied to the daemon. 80 * `GET /info` now returns a `Warnings` field, containing warnings and informational 81 messages about missing features, or issues related to the daemon configuration. 82 * `POST /swarm/init` now accepts a `DefaultAddrPool` property to set global scope default address pool 83 * `POST /swarm/init` now accepts a `SubnetSize` property to set global scope networks by giving the 84 length of the subnet masks for every such network 85 86 ## V1.38 API changes 87 88 [Docker Engine API v1.38](https://docs.docker.com/engine/api/v1.38/) documentation 89 90 91 * `GET /tasks` and `GET /tasks/{id}` now return a `NetworkAttachmentSpec` field, 92 containing the `ContainerID` for non-service containers connected to "attachable" 93 swarm-scoped networks. 94 95 ## v1.37 API changes 96 97 [Docker Engine API v1.37](https://docs.docker.com/engine/api/v1.37/) documentation 98 99 * `POST /containers/create` and `POST /services/create` now supports exposing SCTP ports. 100 * `POST /configs/create` and `POST /configs/{id}/create` now accept a `Templating` driver. 101 * `GET /configs` and `GET /configs/{id}` now return the `Templating` driver of the config. 102 * `POST /secrets/create` and `POST /secrets/{id}/create` now accept a `Templating` driver. 103 * `GET /secrets` and `GET /secrets/{id}` now return the `Templating` driver of the secret. 104 105 ## v1.36 API changes 106 107 [Docker Engine API v1.36](https://docs.docker.com/engine/api/v1.36/) documentation 108 109 * `Get /events` now return `exec_die` event when an exec process terminates. 110 111 112 ## v1.35 API changes 113 114 [Docker Engine API v1.35](https://docs.docker.com/engine/api/v1.35/) documentation 115 116 * `POST /services/create` and `POST /services/(id)/update` now accepts an 117 `Isolation` field on container spec to set the Isolation technology of the 118 containers running the service (`default`, `process`, or `hyperv`). This 119 configuration is only used for Windows containers. 120 * `GET /containers/(name)/logs` now supports an additional query parameter: `until`, 121 which returns log lines that occurred before the specified timestamp. 122 * `POST /containers/{id}/exec` now accepts a `WorkingDir` property to set the 123 work-dir for the exec process, independent of the container's work-dir. 124 * `Get /version` now returns a `Platform.Name` field, which can be used by products 125 using Moby as a foundation to return information about the platform. 126 * `Get /version` now returns a `Components` field, which can be used to return 127 information about the components used. Information about the engine itself is 128 now included as a "Component" version, and contains all information from the 129 top-level `Version`, `GitCommit`, `APIVersion`, `MinAPIVersion`, `GoVersion`, 130 `Os`, `Arch`, `BuildTime`, `KernelVersion`, and `Experimental` fields. Going 131 forward, the information from the `Components` section is preferred over their 132 top-level counterparts. 133 134 135 ## v1.34 API changes 136 137 [Docker Engine API v1.34](https://docs.docker.com/engine/api/v1.34/) documentation 138 139 * `POST /containers/(name)/wait?condition=removed` now also also returns 140 in case of container removal failure. A pointer to a structure named 141 `Error` added to the response JSON in order to indicate a failure. 142 If `Error` is `null`, container removal has succeeded, otherwise 143 the test of an error message indicating why container removal has failed 144 is available from `Error.Message` field. 145 146 ## v1.33 API changes 147 148 [Docker Engine API v1.33](https://docs.docker.com/engine/api/v1.33/) documentation 149 150 * `GET /events` now supports filtering 4 more kinds of events: `config`, `node`, 151 `secret` and `service`. 152 153 ## v1.32 API changes 154 155 [Docker Engine API v1.32](https://docs.docker.com/engine/api/v1.32/) documentation 156 157 * `POST /containers/create` now accepts additional values for the 158 `HostConfig.IpcMode` property. New values are `private`, `shareable`, 159 and `none`. 160 * `DELETE /networks/{id or name}` fixed issue where a `name` equal to another 161 network's name was able to mask that `id`. If both a network with the given 162 _name_ exists, and a network with the given _id_, the network with the given 163 _id_ is now deleted. This change is not versioned, and affects all API versions 164 if the daemon has this patch. 165 166 ## v1.31 API changes 167 168 [Docker Engine API v1.31](https://docs.docker.com/engine/api/v1.31/) documentation 169 170 * `DELETE /secrets/(name)` now returns status code 404 instead of 500 when the secret does not exist. 171 * `POST /secrets/create` now returns status code 409 instead of 500 when creating an already existing secret. 172 * `POST /secrets/create` now accepts a `Driver` struct, allowing the 173 `Name` and driver-specific `Options` to be passed to store a secrets 174 in an external secrets store. The `Driver` property can be omitted 175 if the default (internal) secrets store is used. 176 * `GET /secrets/(id)` and `GET /secrets` now return a `Driver` struct, 177 containing the `Name` and driver-specific `Options` of the external 178 secrets store used to store the secret. The `Driver` property is 179 omitted if no external store is used. 180 * `POST /secrets/(name)/update` now returns status code 400 instead of 500 when updating a secret's content which is not the labels. 181 * `POST /nodes/(name)/update` now returns status code 400 instead of 500 when demoting last node fails. 182 * `GET /networks/(id or name)` now takes an optional query parameter `scope` that will filter the network based on the scope (`local`, `swarm`, or `global`). 183 * `POST /session` is a new endpoint that can be used for running interactive long-running protocols between client and 184 the daemon. This endpoint is experimental and only available if the daemon is started with experimental features 185 enabled. 186 * `GET /images/(name)/get` now includes an `ImageMetadata` field which contains image metadata that is local to the engine and not part of the image config. 187 * `POST /services/create` now accepts a `PluginSpec` when `TaskTemplate.Runtime` is set to `plugin` 188 * `GET /events` now supports config events `create`, `update` and `remove` that are emitted when users create, update or remove a config 189 * `GET /volumes/` and `GET /volumes/{name}` now return a `CreatedAt` field, 190 containing the date/time the volume was created. This field is omitted if the 191 creation date/time for the volume is unknown. For volumes with scope "global", 192 this field represents the creation date/time of the local _instance_ of the 193 volume, which may differ from instances of the same volume on different nodes. 194 * `GET /system/df` now returns a `CreatedAt` field for `Volumes`. Refer to the 195 `/volumes/` endpoint for a description of this field. 196 197 ## v1.30 API changes 198 199 [Docker Engine API v1.30](https://docs.docker.com/engine/api/v1.30/) documentation 200 201 * `GET /info` now returns the list of supported logging drivers, including plugins. 202 * `GET /info` and `GET /swarm` now returns the cluster-wide swarm CA info if the node is in a swarm: the cluster root CA certificate, and the cluster TLS 203 leaf certificate issuer's subject and public key. It also displays the desired CA signing certificate, if any was provided as part of the spec. 204 * `POST /build/` now (when not silent) produces an `Aux` message in the JSON output stream with payload `types.BuildResult` for each image produced. The final such message will reference the image resulting from the build. 205 * `GET /nodes` and `GET /nodes/{id}` now returns additional information about swarm TLS info if the node is part of a swarm: the trusted root CA, and the 206 issuer's subject and public key. 207 * `GET /distribution/(name)/json` is a new endpoint that returns a JSON output stream with payload `types.DistributionInspect` for an image name. It includes a descriptor with the digest, and supported platforms retrieved from directly contacting the registry. 208 * `POST /swarm/update` now accepts 3 additional parameters as part of the swarm spec's CA configuration; the desired CA certificate for 209 the swarm, the desired CA key for the swarm (if not using an external certificate), and an optional parameter to force swarm to 210 generate and rotate to a new CA certificate/key pair. 211 * `POST /service/create` and `POST /services/(id or name)/update` now take the field `Platforms` as part of the service `Placement`, allowing to specify platforms supported by the service. 212 * `POST /containers/(name)/wait` now accepts a `condition` query parameter to indicate which state change condition to wait for. Also, response headers are now returned immediately to acknowledge that the server has registered a wait callback for the client. 213 * `POST /swarm/init` now accepts a `DataPathAddr` property to set the IP-address or network interface to use for data traffic 214 * `POST /swarm/join` now accepts a `DataPathAddr` property to set the IP-address or network interface to use for data traffic 215 * `GET /events` now supports service, node and secret events which are emitted when users create, update and remove service, node and secret 216 * `GET /events` now supports network remove event which is emitted when users remove a swarm scoped network 217 * `GET /events` now supports a filter type `scope` in which supported value could be swarm and local 218 219 ## v1.29 API changes 220 221 [Docker Engine API v1.29](https://docs.docker.com/engine/api/v1.29/) documentation 222 223 * `DELETE /networks/(name)` now allows to remove the ingress network, the one used to provide the routing-mesh. 224 * `POST /networks/create` now supports creating the ingress network, by specifying an `Ingress` boolean field. As of now this is supported only when using the overlay network driver. 225 * `GET /networks/(name)` now returns an `Ingress` field showing whether the network is the ingress one. 226 * `GET /networks/` now supports a `scope` filter to filter networks based on the network mode (`swarm`, `global`, or `local`). 227 * `POST /containers/create`, `POST /service/create` and `POST /services/(id or name)/update` now takes the field `StartPeriod` as a part of the `HealthConfig` allowing for specification of a period during which the container should not be considered unhealthy even if health checks do not pass. 228 * `GET /services/(id)` now accepts an `insertDefaults` query-parameter to merge default values into the service inspect output. 229 * `POST /containers/prune`, `POST /images/prune`, `POST /volumes/prune`, and `POST /networks/prune` now support a `label` filter to filter containers, images, volumes, or networks based on the label. The format of the label filter could be `label=<key>`/`label=<key>=<value>` to remove those with the specified labels, or `label!=<key>`/`label!=<key>=<value>` to remove those without the specified labels. 230 * `POST /services/create` now accepts `Privileges` as part of `ContainerSpec`. Privileges currently include 231 `CredentialSpec` and `SELinuxContext`. 232 233 ## v1.28 API changes 234 235 [Docker Engine API v1.28](https://docs.docker.com/engine/api/v1.28/) documentation 236 237 * `POST /containers/create` now includes a `Consistency` field to specify the consistency level for each `Mount`, with possible values `default`, `consistent`, `cached`, or `delegated`. 238 * `GET /containers/create` now takes a `DeviceCgroupRules` field in `HostConfig` allowing to set custom device cgroup rules for the created container. 239 * Optional query parameter `verbose` for `GET /networks/(id or name)` will now list all services with all the tasks, including the non-local tasks on the given network. 240 * `GET /containers/(id or name)/attach/ws` now returns WebSocket in binary frame format for API version >= v1.28, and returns WebSocket in text frame format for API version< v1.28, for the purpose of backward-compatibility. 241 * `GET /networks` is optimised only to return list of all networks and network specific information. List of all containers attached to a specific network is removed from this API and is only available using the network specific `GET /networks/{network-id}. 242 * `GET /containers/json` now supports `publish` and `expose` filters to filter containers that expose or publish certain ports. 243 * `POST /services/create` and `POST /services/(id or name)/update` now accept the `ReadOnly` parameter, which mounts the container's root filesystem as read only. 244 * `POST /build` now accepts `extrahosts` parameter to specify a host to ip mapping to use during the build. 245 * `POST /services/create` and `POST /services/(id or name)/update` now accept a `rollback` value for `FailureAction`. 246 * `POST /services/create` and `POST /services/(id or name)/update` now accept an optional `RollbackConfig` object which specifies rollback options. 247 * `GET /services` now supports a `mode` filter to filter services based on the service mode (either `global` or `replicated`). 248 * `POST /containers/(name)/update` now supports updating `NanoCPUs` that represents CPU quota in units of 10<sup>-9</sup> CPUs. 249 250 ## v1.27 API changes 251 252 [Docker Engine API v1.27](https://docs.docker.com/engine/api/v1.27/) documentation 253 254 * `GET /containers/(id or name)/stats` now includes an `online_cpus` field in both `precpu_stats` and `cpu_stats`. If this field is `nil` then for compatibility with older daemons the length of the corresponding `cpu_usage.percpu_usage` array should be used. 255 256 ## v1.26 API changes 257 258 [Docker Engine API v1.26](https://docs.docker.com/engine/api/v1.26/) documentation 259 260 * `POST /plugins/(plugin name)/upgrade` upgrade a plugin. 261 262 ## v1.25 API changes 263 264 [Docker Engine API v1.25](https://docs.docker.com/engine/api/v1.25/) documentation 265 266 * The API version is now required in all API calls. Instead of just requesting, for example, the URL `/containers/json`, you must now request `/v1.25/containers/json`. 267 * `GET /version` now returns `MinAPIVersion`. 268 * `POST /build` accepts `networkmode` parameter to specify network used during build. 269 * `GET /images/(name)/json` now returns `OsVersion` if populated 270 * `GET /info` now returns `Isolation`. 271 * `POST /containers/create` now takes `AutoRemove` in HostConfig, to enable auto-removal of the container on daemon side when the container's process exits. 272 * `GET /containers/json` and `GET /containers/(id or name)/json` now return `"removing"` as a value for the `State.Status` field if the container is being removed. Previously, "exited" was returned as status. 273 * `GET /containers/json` now accepts `removing` as a valid value for the `status` filter. 274 * `GET /containers/json` now supports filtering containers by `health` status. 275 * `DELETE /volumes/(name)` now accepts a `force` query parameter to force removal of volumes that were already removed out of band by the volume driver plugin. 276 * `POST /containers/create/` and `POST /containers/(name)/update` now validates restart policies. 277 * `POST /containers/create` now validates IPAMConfig in NetworkingConfig, and returns error for invalid IPv4 and IPv6 addresses (`--ip` and `--ip6` in `docker create/run`). 278 * `POST /containers/create` now takes a `Mounts` field in `HostConfig` which replaces `Binds`, `Volumes`, and `Tmpfs`. *note*: `Binds`, `Volumes`, and `Tmpfs` are still available and can be combined with `Mounts`. 279 * `POST /build` now performs a preliminary validation of the `Dockerfile` before starting the build, and returns an error if the syntax is incorrect. Note that this change is _unversioned_ and applied to all API versions. 280 * `POST /build` accepts `cachefrom` parameter to specify images used for build cache. 281 * `GET /networks/` endpoint now correctly returns a list of *all* networks, 282 instead of the default network if a trailing slash is provided, but no `name` 283 or `id`. 284 * `DELETE /containers/(name)` endpoint now returns an error of `removal of container name is already in progress` with status code of 400, when container name is in a state of removal in progress. 285 * `GET /containers/json` now supports a `is-task` filter to filter 286 containers that are tasks (part of a service in swarm mode). 287 * `POST /containers/create` now takes `StopTimeout` field. 288 * `POST /services/create` and `POST /services/(id or name)/update` now accept `Monitor` and `MaxFailureRatio` parameters, which control the response to failures during service updates. 289 * `POST /services/(id or name)/update` now accepts a `ForceUpdate` parameter inside the `TaskTemplate`, which causes the service to be updated even if there are no changes which would ordinarily trigger an update. 290 * `POST /services/create` and `POST /services/(id or name)/update` now return a `Warnings` array. 291 * `GET /networks/(name)` now returns field `Created` in response to show network created time. 292 * `POST /containers/(id or name)/exec` now accepts an `Env` field, which holds a list of environment variables to be set in the context of the command execution. 293 * `GET /volumes`, `GET /volumes/(name)`, and `POST /volumes/create` now return the `Options` field which holds the driver specific options to use for when creating the volume. 294 * `GET /exec/(id)/json` now returns `Pid`, which is the system pid for the exec'd process. 295 * `POST /containers/prune` prunes stopped containers. 296 * `POST /images/prune` prunes unused images. 297 * `POST /volumes/prune` prunes unused volumes. 298 * `POST /networks/prune` prunes unused networks. 299 * Every API response now includes a `Docker-Experimental` header specifying if experimental features are enabled (value can be `true` or `false`). 300 * Every API response now includes a `API-Version` header specifying the default API version of the server. 301 * The `hostConfig` option now accepts the fields `CpuRealtimePeriod` and `CpuRtRuntime` to allocate cpu runtime to rt tasks when `CONFIG_RT_GROUP_SCHED` is enabled in the kernel. 302 * The `SecurityOptions` field within the `GET /info` response now includes `userns` if user namespaces are enabled in the daemon. 303 * `GET /nodes` and `GET /node/(id or name)` now return `Addr` as part of a node's `Status`, which is the address that that node connects to the manager from. 304 * The `HostConfig` field now includes `NanoCPUs` that represents CPU quota in units of 10<sup>-9</sup> CPUs. 305 * `GET /info` now returns more structured information about security options. 306 * The `HostConfig` field now includes `CpuCount` that represents the number of CPUs available for execution by the container. Windows daemon only. 307 * `POST /services/create` and `POST /services/(id or name)/update` now accept the `TTY` parameter, which allocate a pseudo-TTY in container. 308 * `POST /services/create` and `POST /services/(id or name)/update` now accept the `DNSConfig` parameter, which specifies DNS related configurations in resolver configuration file (resolv.conf) through `Nameservers`, `Search`, and `Options`. 309 * `GET /networks/(id or name)` now includes IP and name of all peers nodes for swarm mode overlay networks. 310 * `GET /plugins` list plugins. 311 * `POST /plugins/pull?name=<plugin name>` pulls a plugin. 312 * `GET /plugins/(plugin name)` inspect a plugin. 313 * `POST /plugins/(plugin name)/set` configure a plugin. 314 * `POST /plugins/(plugin name)/enable` enable a plugin. 315 * `POST /plugins/(plugin name)/disable` disable a plugin. 316 * `POST /plugins/(plugin name)/push` push a plugin. 317 * `POST /plugins/create?name=(plugin name)` create a plugin. 318 * `DELETE /plugins/(plugin name)` delete a plugin. 319 * `POST /node/(id or name)/update` now accepts both `id` or `name` to identify the node to update. 320 * `GET /images/json` now support a `reference` filter. 321 * `GET /secrets` returns information on the secrets. 322 * `POST /secrets/create` creates a secret. 323 * `DELETE /secrets/{id}` removes the secret `id`. 324 * `GET /secrets/{id}` returns information on the secret `id`. 325 * `POST /secrets/{id}/update` updates the secret `id`. 326 * `POST /services/(id or name)/update` now accepts service name or prefix of service id as a parameter. 327 * `POST /containers/create` added 2 built-in log-opts that work on all logging drivers, 328 `mode` (`blocking`|`non-blocking`), and `max-buffer-size` (e.g. `2m`) which enables a non-blocking log buffer. 329 * `POST /containers/create` now takes `HostConfig.Init` field to run an init 330 inside the container that forwards signals and reaps processes. 331 332 ## v1.24 API changes 333 334 [Docker Engine API v1.24](v1.24.md) documentation 335 336 * `POST /containers/create` now takes `StorageOpt` field. 337 * `GET /info` now returns `SecurityOptions` field, showing if `apparmor`, `seccomp`, or `selinux` is supported. 338 * `GET /info` no longer returns the `ExecutionDriver` property. This property was no longer used after integration 339 with ContainerD in Docker 1.11. 340 * `GET /networks` now supports filtering by `label` and `driver`. 341 * `GET /containers/json` now supports filtering containers by `network` name or id. 342 * `POST /containers/create` now takes `IOMaximumBandwidth` and `IOMaximumIOps` fields. Windows daemon only. 343 * `POST /containers/create` now returns an HTTP 400 "bad parameter" message 344 if no command is specified (instead of an HTTP 500 "server error") 345 * `GET /images/search` now takes a `filters` query parameter. 346 * `GET /events` now supports a `reload` event that is emitted when the daemon configuration is reloaded. 347 * `GET /events` now supports filtering by daemon name or ID. 348 * `GET /events` now supports a `detach` event that is emitted on detaching from container process. 349 * `GET /events` now supports an `exec_detach ` event that is emitted on detaching from exec process. 350 * `GET /images/json` now supports filters `since` and `before`. 351 * `POST /containers/(id or name)/start` no longer accepts a `HostConfig`. 352 * `POST /images/(name)/tag` no longer has a `force` query parameter. 353 * `GET /images/search` now supports maximum returned search results `limit`. 354 * `POST /containers/{name:.*}/copy` is now removed and errors out starting from this API version. 355 * API errors are now returned as JSON instead of plain text. 356 * `POST /containers/create` and `POST /containers/(id)/start` allow you to configure kernel parameters (sysctls) for use in the container. 357 * `POST /containers/<container ID>/exec` and `POST /exec/<exec ID>/start` 358 no longer expects a "Container" field to be present. This property was not used 359 and is no longer sent by the docker client. 360 * `POST /containers/create/` now validates the hostname (should be a valid RFC 1123 hostname). 361 * `POST /containers/create/` `HostConfig.PidMode` field now accepts `container:<name|id>`, 362 to have the container join the PID namespace of an existing container. 363 364 ## v1.23 API changes 365 366 [Docker Engine API v1.23](v1.23.md) documentation 367 368 * `GET /containers/json` returns the state of the container, one of `created`, `restarting`, `running`, `paused`, `exited` or `dead`. 369 * `GET /containers/json` returns the mount points for the container. 370 * `GET /networks/(name)` now returns an `Internal` field showing whether the network is internal or not. 371 * `GET /networks/(name)` now returns an `EnableIPv6` field showing whether the network has ipv6 enabled or not. 372 * `POST /containers/(name)/update` now supports updating container's restart policy. 373 * `POST /networks/create` now supports enabling ipv6 on the network by setting the `EnableIPv6` field (doing this with a label will no longer work). 374 * `GET /info` now returns `CgroupDriver` field showing what cgroup driver the daemon is using; `cgroupfs` or `systemd`. 375 * `GET /info` now returns `KernelMemory` field, showing if "kernel memory limit" is supported. 376 * `POST /containers/create` now takes `PidsLimit` field, if the kernel is >= 4.3 and the pids cgroup is supported. 377 * `GET /containers/(id or name)/stats` now returns `pids_stats`, if the kernel is >= 4.3 and the pids cgroup is supported. 378 * `POST /containers/create` now allows you to override usernamespaces remapping and use privileged options for the container. 379 * `POST /containers/create` now allows specifying `nocopy` for named volumes, which disables automatic copying from the container path to the volume. 380 * `POST /auth` now returns an `IdentityToken` when supported by a registry. 381 * `POST /containers/create` with both `Hostname` and `Domainname` fields specified will result in the container's hostname being set to `Hostname`, rather than `Hostname.Domainname`. 382 * `GET /volumes` now supports more filters, new added filters are `name` and `driver`. 383 * `GET /containers/(id or name)/logs` now accepts a `details` query parameter to stream the extra attributes that were provided to the containers `LogOpts`, such as environment variables and labels, with the logs. 384 * `POST /images/load` now returns progress information as a JSON stream, and has a `quiet` query parameter to suppress progress details. 385 386 ## v1.22 API changes 387 388 [Docker Engine API v1.22](v1.22.md) documentation 389 390 * `POST /container/(name)/update` updates the resources of a container. 391 * `GET /containers/json` supports filter `isolation` on Windows. 392 * `GET /containers/json` now returns the list of networks of containers. 393 * `GET /info` Now returns `Architecture` and `OSType` fields, providing information 394 about the host architecture and operating system type that the daemon runs on. 395 * `GET /networks/(name)` now returns a `Name` field for each container attached to the network. 396 * `GET /version` now returns the `BuildTime` field in RFC3339Nano format to make it 397 consistent with other date/time values returned by the API. 398 * `AuthConfig` now supports a `registrytoken` for token based authentication 399 * `POST /containers/create` now has a 4M minimum value limit for `HostConfig.KernelMemory` 400 * Pushes initiated with `POST /images/(name)/push` and pulls initiated with `POST /images/create` 401 will be cancelled if the HTTP connection making the API request is closed before 402 the push or pull completes. 403 * `POST /containers/create` now allows you to set a read/write rate limit for a 404 device (in bytes per second or IO per second). 405 * `GET /networks` now supports filtering by `name`, `id` and `type`. 406 * `POST /containers/create` now allows you to set the static IPv4 and/or IPv6 address for the container. 407 * `POST /networks/(id)/connect` now allows you to set the static IPv4 and/or IPv6 address for the container. 408 * `GET /info` now includes the number of containers running, stopped, and paused. 409 * `POST /networks/create` now supports restricting external access to the network by setting the `Internal` field. 410 * `POST /networks/(id)/disconnect` now includes a `Force` option to forcefully disconnect a container from network 411 * `GET /containers/(id)/json` now returns the `NetworkID` of containers. 412 * `POST /networks/create` Now supports an options field in the IPAM config that provides options 413 for custom IPAM plugins. 414 * `GET /networks/{network-id}` Now returns IPAM config options for custom IPAM plugins if any 415 are available. 416 * `GET /networks/<network-id>` now returns subnets info for user-defined networks. 417 * `GET /info` can now return a `SystemStatus` field useful for returning additional information about applications 418 that are built on top of engine. 419 420 ## v1.21 API changes 421 422 [Docker Engine API v1.21](v1.21.md) documentation 423 424 * `GET /volumes` lists volumes from all volume drivers. 425 * `POST /volumes/create` to create a volume. 426 * `GET /volumes/(name)` get low-level information about a volume. 427 * `DELETE /volumes/(name)` remove a volume with the specified name. 428 * `VolumeDriver` was moved from `config` to `HostConfig` to make the configuration portable. 429 * `GET /images/(name)/json` now returns information about an image's `RepoTags` and `RepoDigests`. 430 * The `config` option now accepts the field `StopSignal`, which specifies the signal to use to kill a container. 431 * `GET /containers/(id)/stats` will return networking information respectively for each interface. 432 * The `HostConfig` option now includes the `DnsOptions` field to configure the container's DNS options. 433 * `POST /build` now optionally takes a serialized map of build-time variables. 434 * `GET /events` now includes a `timenano` field, in addition to the existing `time` field. 435 * `GET /events` now supports filtering by image and container labels. 436 * `GET /info` now lists engine version information and return the information of `CPUShares` and `Cpuset`. 437 * `GET /containers/json` will return `ImageID` of the image used by container. 438 * `POST /exec/(name)/start` will now return an HTTP 409 when the container is either stopped or paused. 439 * `POST /containers/create` now takes `KernelMemory` in HostConfig to specify kernel memory limit. 440 * `GET /containers/(name)/json` now accepts a `size` parameter. Setting this parameter to '1' returns container size information in the `SizeRw` and `SizeRootFs` fields. 441 * `GET /containers/(name)/json` now returns a `NetworkSettings.Networks` field, 442 detailing network settings per network. This field deprecates the 443 `NetworkSettings.Gateway`, `NetworkSettings.IPAddress`, 444 `NetworkSettings.IPPrefixLen`, and `NetworkSettings.MacAddress` fields, which 445 are still returned for backward-compatibility, but will be removed in a future version. 446 * `GET /exec/(id)/json` now returns a `NetworkSettings.Networks` field, 447 detailing networksettings per network. This field deprecates the 448 `NetworkSettings.Gateway`, `NetworkSettings.IPAddress`, 449 `NetworkSettings.IPPrefixLen`, and `NetworkSettings.MacAddress` fields, which 450 are still returned for backward-compatibility, but will be removed in a future version. 451 * The `HostConfig` option now includes the `OomScoreAdj` field for adjusting the 452 badness heuristic. This heuristic selects which processes the OOM killer kills 453 under out-of-memory conditions. 454 455 ## v1.20 API changes 456 457 [Docker Engine API v1.20](v1.20.md) documentation 458 459 * `GET /containers/(id)/archive` get an archive of filesystem content from a container. 460 * `PUT /containers/(id)/archive` upload an archive of content to be extracted to 461 an existing directory inside a container's filesystem. 462 * `POST /containers/(id)/copy` is deprecated in favor of the above `archive` 463 endpoint which can be used to download files and directories from a container. 464 * The `hostConfig` option now accepts the field `GroupAdd`, which specifies a 465 list of additional groups that the container process will run as. 466 467 ## v1.19 API changes 468 469 [Docker Engine API v1.19](v1.19.md) documentation 470 471 * When the daemon detects a version mismatch with the client, usually when 472 the client is newer than the daemon, an HTTP 400 is now returned instead 473 of a 404. 474 * `GET /containers/(id)/stats` now accepts `stream` bool to get only one set of stats and disconnect. 475 * `GET /containers/(id)/logs` now accepts a `since` timestamp parameter. 476 * `GET /info` The fields `Debug`, `IPv4Forwarding`, `MemoryLimit`, and 477 `SwapLimit` are now returned as boolean instead of as an int. In addition, the 478 end point now returns the new boolean fields `CpuCfsPeriod`, `CpuCfsQuota`, and 479 `OomKillDisable`. 480 * The `hostConfig` option now accepts the fields `CpuPeriod` and `CpuQuota` 481 * `POST /build` accepts `cpuperiod` and `cpuquota` options 482 483 ## v1.18 API changes 484 485 [Docker Engine API v1.18](v1.18.md) documentation 486 487 * `GET /version` now returns `Os`, `Arch` and `KernelVersion`. 488 * `POST /containers/create` and `POST /containers/(id)/start`allow you to set ulimit settings for use in the container. 489 * `GET /info` now returns `SystemTime`, `HttpProxy`,`HttpsProxy` and `NoProxy`. 490 * `GET /images/json` added a `RepoDigests` field to include image digest information. 491 * `POST /build` can now set resource constraints for all containers created for the build. 492 * `CgroupParent` can be passed in the host config to setup container cgroups under a specific cgroup. 493 * `POST /build` closing the HTTP request cancels the build 494 * `POST /containers/(id)/exec` includes `Warnings` field to response.