github.com/Prakhar-Agarwal-byte/moby@v0.0.0-20231027092010-a14e3e8ab87e/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.44 API changes 17 18 [Docker Engine API v1.44](https://docs.docker.com/engine/api/v1.44/) documentation 19 20 * The `VirtualSize` field in the `GET /images/{name}/json`, `GET /images/json`, 21 and `GET /system/df` responses is now omitted. Use the `Size` field instead, 22 which contains the same information. 23 * Deprecated: The `is_automated` field in the `GET /images/search` response has 24 been deprecated and will always be set to false in the future because Docker 25 Hub is deprecating the `is_automated` field in its search API. The deprecation 26 is not versioned, and applies to all API versions. 27 * Deprecated: The `is-automated` filter for the `GET /images/search` endpoint. 28 The `is_automated` field has been deprecated by Docker Hub's search API. 29 Consequently, searching for `is-automated=true` will yield no results. The 30 deprecation is not versioned, and applies to all API versions. 31 * Read-only bind mounts are now made recursively read-only on kernel >= 5.12 32 with runtimes which support the feature. 33 `POST /containers/create`, `GET /containers/{id}/json`, and `GET /containers/json` now supports 34 `BindOptions.ReadOnlyNonRecursive` and `BindOptions.ReadOnlyForceRecursive` to customize the behavior. 35 * `POST /containers/create` now accepts a `HealthConfig.StartInterval` to set the 36 interval for health checks during the start period. 37 * `GET /info` now includes a `CDISpecDirs` field indicating the configured CDI 38 specifications directories. The use of the applied setting requires the daemon 39 to have expermental enabled, and for non-experimental daemons an empty list is 40 always returned. 41 * `POST /networks/create` now returns a 400 if the `IPAMConfig` has invalid 42 values. Note that this change is _unversioned_ and applied to all API 43 versions on daemon that support version 1.44. 44 * `POST /networks/create` with a duplicated name now fails systematically. As 45 such, the `CheckDuplicate` field is now deprecated. Note that this change is 46 _unversioned_ and applied to all API versions on daemon that support version 47 1.44. 48 * `POST /containers/create` now accepts multiple `EndpointSettings` in 49 `NetworkingConfig.EndpointSettings`. 50 * `POST /containers/create` and `POST /networks/{id}/connect` will now catch 51 validation errors that were previously only returned during `POST /containers/{id}/start`. 52 These endpoints will also return the full set of validation errors they find, 53 instead of returning only the first one. 54 Note that this change is _unversioned_ and applies to all API versions. 55 * `POST /services/create` and `POST /services/{id}/update` now accept `Seccomp` 56 and `AppArmor` fields in the `ContainerSpec.Privileges` object. This allows 57 some configuration of Seccomp and AppArmor in Swarm services. 58 59 ## v1.43 API changes 60 61 [Docker Engine API v1.43](https://docs.docker.com/engine/api/v1.43/) documentation 62 63 * `POST /containers/create` now accepts `Annotations` as part of `HostConfig`. 64 Can be used to attach arbitrary metadata to the container, which will also be 65 passed to the runtime when the container is started. 66 * `GET /images/json` no longer includes hardcoded `<none>:<none>` and 67 `<none>@<none>` in `RepoTags` and`RepoDigests` for untagged images. 68 In such cases, empty arrays will be produced instead. 69 * The `VirtualSize` field in the `GET /images/{name}/json`, `GET /images/json`, 70 and `GET /system/df` responses is deprecated and will no longer be included 71 in API v1.44. Use the `Size` field instead, which contains the same information. 72 * `GET /info` now includes `no-new-privileges` in the `SecurityOptions` string 73 list when this option is enabled globally. This change is not versioned, and 74 affects all API versions if the daemon has this patch. 75 76 ## v1.42 API changes 77 78 [Docker Engine API v1.42](https://docs.docker.com/engine/api/v1.42/) documentation 79 80 * Removed the `BuilderSize` field on the `GET /system/df` endpoint. This field 81 was introduced in API 1.31 as part of an experimental feature, and no longer 82 used since API 1.40. 83 Use field `BuildCache` instead to track storage used by the builder component. 84 * `POST /containers/{id}/stop` and `POST /containers/{id}/restart` now accept a 85 `signal` query parameter, which allows overriding the container's default stop- 86 signal. 87 * `GET /images/json` now accepts query parameter `shared-size`. When set `true`, 88 images returned will include `SharedSize`, which provides the size on disk shared 89 with other images present on the system. 90 * `GET /system/df` now accepts query parameter `type`. When set, 91 computes and returns data only for the specified object type. 92 The parameter can be specified multiple times to select several object types. 93 Supported values are: `container`, `image`, `volume`, `build-cache`. 94 * `GET /system/df` can now be used concurrently. If a request is made while a 95 previous request is still being processed, the request will receive the result 96 of the already running calculation, once completed. Previously, an error 97 (`a disk usage operation is already running`) would be returned in this 98 situation. This change is not versioned, and affects all API versions if the 99 daemon has this patch. 100 * The `POST /images/create` now supports both the operating system and architecture 101 that is passed through the `platform` query parameter when using the `fromSrc` 102 option to import an image from an archive. Previously, only the operating system 103 was used and the architecture was ignored. If no `platform` option is set, the 104 host's operating system and architecture as used as default. This change is not 105 versioned, and affects all API versions if the daemon has this patch. 106 * The `POST /containers/{id}/wait` endpoint now returns a `400` status code if an 107 invalid `condition` is provided (on API 1.30 and up). 108 * Removed the `KernelMemory` field from the `POST /containers/create` and 109 `POST /containers/{id}/update` endpoints, any value it is set to will be ignored 110 on API version `v1.42` and up. Older API versions still accept this field, but 111 may take no effect, depending on the kernel version and OCI runtime in use. 112 * `GET /containers/{id}/json` now omits the `KernelMemory` and `KernelMemoryTCP` 113 if they are not set. 114 * `GET /info` now omits the `KernelMemory` and `KernelMemoryTCP` if they are not 115 supported by the host or host's configuration (if cgroups v2 are in use). 116 * `GET /_ping` and `HEAD /_ping` now return `Builder-Version` by default. 117 This header contains the default builder to use, and is a recommendation as 118 advertised by the daemon. However, it is up to the client to choose which builder 119 to use. 120 121 The default value on Linux is version "2" (BuildKit), but the daemon can be 122 configured to recommend version "1" (classic Builder). Windows does not yet 123 support BuildKit for native Windows images, and uses "1" (classic builder) as 124 a default. 125 126 This change is not versioned, and affects all API versions if the daemon has 127 this patch. 128 * `GET /_ping` and `HEAD /_ping` now return a `Swarm` header, which allows a 129 client to detect if Swarm is enabled on the daemon, without having to call 130 additional endpoints. 131 This change is not versioned, and affects all API versions if the daemon has 132 this patch. Clients must consider this header "optional", and fall back to 133 using other endpoints to get this information if the header is not present. 134 135 The `Swarm` header can contain one of the following values: 136 137 - "inactive" 138 - "pending" 139 - "error" 140 - "locked" 141 - "active/worker" 142 - "active/manager" 143 * `POST /containers/create` for Windows containers now accepts a new syntax in 144 `HostConfig.Resources.Devices.PathOnHost`. As well as the existing `class/<GUID>` 145 syntax, `<IDType>://<ID>` is now recognised. Support for specific `<IDType>` values 146 depends on the underlying implementation and Windows version. This change is not 147 versioned, and affects all API versions if the daemon has this patch. 148 * `GET /containers/{id}/attach`, `GET /exec/{id}/start`, `GET /containers/{id}/logs` 149 `GET /services/{id}/logs` and `GET /tasks/{id}/logs` now set Content-Type header 150 to `application/vnd.docker.multiplexed-stream` when a multiplexed stdout/stderr 151 stream is sent to client, `application/vnd.docker.raw-stream` otherwise. 152 * `POST /volumes/create` now accepts a new `ClusterVolumeSpec` to create a cluster 153 volume (CNI). This option can only be used if the daemon is a Swarm manager. 154 The Volume response on creation now also can contain a `ClusterVolume` field 155 with information about the created volume. 156 * The `BuildCache.Parent` field, as returned by `GET /system/df` is deprecated 157 and is now omitted. API versions before v1.42 continue to include this field. 158 * `GET /system/df` now includes a new `Parents` field, for "build-cache" records, 159 which contains a list of parent IDs for the build-cache record. 160 * Volume information returned by `GET /volumes/{name}`, `GET /volumes` and 161 `GET /system/df` can now contain a `ClusterVolume` if the volume is a cluster 162 volume (requires the daemon to be a Swarm manager). 163 * The `Volume` type, as returned by `Added new `ClusterVolume` fields 164 * Added a new `PUT /volumes{name}` endpoint to update cluster volumes (CNI). 165 Cluster volumes are only supported if the daemon is a Swarm manager. 166 * `GET /containers/{name}/attach/ws` endpoint now accepts `stdin`, `stdout` and 167 `stderr` query parameters to only attach to configured streams. 168 169 NOTE: These parameters were documented before in older API versions, but not 170 actually supported. API versions before v1.42 continue to ignore these parameters 171 and default to attaching to all streams. To preserve the pre-v1.42 behavior, 172 set all three query parameters (`?stdin=1,stdout=1,stderr=1`). 173 * `POST /containers/create` on Linux now respects the `HostConfig.ConsoleSize` property. 174 Container is immediately created with the desired terminal size and clients no longer 175 need to set the desired size on their own. 176 * `POST /containers/create` allow to set `CreateMountpoint` for host path to be 177 created if missing. This brings parity with `Binds` 178 * `POST /containers/create` rejects request if BindOptions|VolumeOptions|TmpfsOptions 179 is set with a non-matching mount Type. 180 * `POST /containers/{id}/exec` now accepts an optional `ConsoleSize` parameter. 181 It allows to set the console size of the executed process immediately when it's created. 182 * `POST /volumes/prune` will now only prune "anonymous" volumes (volumes which were not given a name) by default. A new filter parameter `all` can be set to a truth-y value (`true`, `1`) to get the old behavior. 183 184 ## v1.41 API changes 185 186 [Docker Engine API v1.41](https://docs.docker.com/engine/api/v1.41/) documentation 187 188 * `GET /events` now returns `prune` events after pruning resources have completed. 189 Prune events are returned for `container`, `network`, `volume`, `image`, and 190 `builder`, and have a `reclaimed` attribute, indicating the amount of space 191 reclaimed (in bytes). 192 * `GET /info` now returns a `CgroupVersion` field, containing the cgroup version. 193 * `GET /info` now returns a `DefaultAddressPools` field, containing a list of 194 custom default address pools for local networks, which can be specified in the 195 `daemon.json` file or `--default-address-pool` dockerd option. 196 * `POST /services/create` and `POST /services/{id}/update` now supports `BindOptions.NonRecursive`. 197 * The `ClusterStore` and `ClusterAdvertise` fields in `GET /info` are deprecated 198 and are now omitted if they contain an empty value. This change is not versioned, 199 and affects all API versions if the daemon has this patch. 200 * The `filter` (singular) query parameter, which was deprecated in favor of the 201 `filters` option in Docker 1.13, has now been removed from the `GET /images/json` 202 endpoint. The parameter remains available when using API version 1.40 or below. 203 * `GET /services` now returns `CapAdd` and `CapDrop` as part of the `ContainerSpec`. 204 * `GET /services/{id}` now returns `CapAdd` and `CapDrop` as part of the `ContainerSpec`. 205 * `POST /services/create` now accepts `CapAdd` and `CapDrop` as part of the `ContainerSpec`. 206 * `POST /services/{id}/update` now accepts `CapAdd` and `CapDrop` as part of the `ContainerSpec`. 207 * `GET /tasks` now returns `CapAdd` and `CapDrop` as part of the `ContainerSpec`. 208 * `GET /tasks/{id}` now returns `CapAdd` and `CapDrop` as part of the `ContainerSpec`. 209 * `GET /services` now returns `Pids` in `TaskTemplate.Resources.Limits`. 210 * `GET /services/{id}` now returns `Pids` in `TaskTemplate.Resources.Limits`. 211 * `POST /services/create` now accepts `Pids` in `TaskTemplate.Resources.Limits`. 212 * `POST /services/{id}/update` now accepts `Pids` in `TaskTemplate.Resources.Limits` 213 to limit the maximum number of PIDs. 214 * `GET /tasks` now returns `Pids` in `TaskTemplate.Resources.Limits`. 215 * `GET /tasks/{id}` now returns `Pids` in `TaskTemplate.Resources.Limits`. 216 * `POST /containers/create` now accepts a `platform` query parameter in the format 217 `os[/arch[/variant]]`. 218 219 When set, the daemon checks if the requested image is present in the local image 220 cache with the given OS and Architecture, and otherwise returns a `404` status. 221 222 If the option is _not_ set, the host's native OS and Architecture are used to 223 look up the image in the image cache. However, if no platform is passed and the 224 given image _does_ exist in the local image cache, but its OS or architecture 225 do not match, the container is created with the available image, and a warning 226 is added to the `Warnings` field in the response, for example; 227 228 WARNING: The requested image's platform (linux/arm64/v8) does not 229 match the detected host platform (linux/amd64) and no 230 specific platform was requested 231 232 * `POST /containers/create` on Linux now accepts the `HostConfig.CgroupnsMode` property. 233 Set the property to `host` to create the container in the daemon's cgroup namespace, or 234 `private` to create the container in its own private cgroup namespace. The per-daemon 235 default is `host`, and can be changed by using the`CgroupNamespaceMode` daemon configuration 236 parameter. 237 * `GET /info` now returns an `OSVersion` field, containing the operating system's 238 version. This change is not versioned, and affects all API versions if the daemon 239 has this patch. 240 * `GET /info` no longer returns the `SystemStatus` field if it does not have a 241 value set. This change is not versioned, and affects all API versions if the 242 daemon has this patch. 243 * `GET /services` now accepts query parameter `status`. When set `true`, 244 services returned will include `ServiceStatus`, which provides Desired, 245 Running, and Completed task counts for the service. 246 * `GET /services` may now include `ReplicatedJob` or `GlobalJob` as the `Mode` 247 in a `ServiceSpec`. 248 * `GET /services/{id}` may now include `ReplicatedJob` or `GlobalJob` as the 249 `Mode` in a `ServiceSpec`. 250 * `POST /services/create` now accepts `ReplicatedJob or `GlobalJob` as the `Mode` 251 in the `ServiceSpec. 252 * `POST /services/{id}/update` accepts updating the fields of the 253 `ReplicatedJob` object in the `ServiceSpec.Mode`. The service mode still 254 cannot be changed, however. 255 * `GET /services` now includes `JobStatus` on Services with mode 256 `ReplicatedJob` or `GlobalJob`. 257 * `GET /services/{id}` now includes `JobStatus` on Services with mode 258 `ReplicatedJob` or `GlobalJob`. 259 * `GET /tasks` now includes `JobIteration` on Tasks spawned from a job-mode 260 service. 261 * `GET /tasks/{id}` now includes `JobIteration` on the task if spawned from a 262 job-mode service. 263 * `GET /containers/{id}/stats` now accepts a query param (`one-shot`) which, when used with `stream=false` fetches a 264 single set of stats instead of waiting for two collection cycles to have 2 CPU stats over a 1 second period. 265 * The `KernelMemory` field in `HostConfig.Resources` is now deprecated. 266 * The `KernelMemory` field in `Info` is now deprecated. 267 * `GET /services` now returns `Ulimits` as part of `ContainerSpec`. 268 * `GET /services/{id}` now returns `Ulimits` as part of `ContainerSpec`. 269 * `POST /services/create` now accepts `Ulimits` as part of `ContainerSpec`. 270 * `POST /services/{id}/update` now accepts `Ulimits` as part of `ContainerSpec`. 271 272 ## v1.40 API changes 273 274 [Docker Engine API v1.40](https://docs.docker.com/engine/api/v1.40/) documentation 275 276 * The `/_ping` endpoint can now be accessed both using `GET` or `HEAD` requests. 277 when accessed using a `HEAD` request, all headers are returned, but the body 278 is empty (`Content-Length: 0`). This change is not versioned, and affects all 279 API versions if the daemon has this patch. Clients are recommended to try 280 using `HEAD`, but fallback to `GET` if the `HEAD` requests fails. 281 * `GET /_ping` and `HEAD /_ping` now set `Cache-Control` and `Pragma` headers to 282 prevent the result from being cached. This change is not versioned, and affects 283 all API versions if the daemon has this patch. 284 * `GET /services` now returns `Sysctls` as part of the `ContainerSpec`. 285 * `GET /services/{id}` now returns `Sysctls` as part of the `ContainerSpec`. 286 * `POST /services/create` now accepts `Sysctls` as part of the `ContainerSpec`. 287 * `POST /services/{id}/update` now accepts `Sysctls` as part of the `ContainerSpec`. 288 * `POST /services/create` now accepts `Config` as part of `ContainerSpec.Privileges.CredentialSpec`. 289 * `POST /services/{id}/update` now accepts `Config` as part of `ContainerSpec.Privileges.CredentialSpec`. 290 * `POST /services/create` now includes `Runtime` as an option in `ContainerSpec.Configs` 291 * `POST /services/{id}/update` now includes `Runtime` as an option in `ContainerSpec.Configs` 292 * `GET /tasks` now returns `Sysctls` as part of the `ContainerSpec`. 293 * `GET /tasks/{id}` now returns `Sysctls` as part of the `ContainerSpec`. 294 * `GET /networks` now supports a `dangling` filter type. When set to `true` (or 295 `1`), the endpoint returns all networks that are not in use by a container. When 296 set to `false` (or `0`), only networks that are in use by one or more containers 297 are returned. 298 * `GET /nodes` now supports a filter type `node.label` filter to filter nodes based 299 on the node.label. The format of the label filter is `node.label=<key>`/`node.label=<key>=<value>` 300 to return those with the specified labels, or `node.label!=<key>`/`node.label!=<key>=<value>` 301 to return those without the specified labels. 302 * `POST /containers/create` now accepts a `fluentd-async` option in `HostConfig.LogConfig.Config` 303 when using the Fluentd logging driver. This option deprecates the `fluentd-async-connect` 304 option, which remains funtional, but will be removed in a future release. Users 305 are encouraged to use the `fluentd-async` option going forward. This change is 306 not versioned, and affects all API versions if the daemon has this patch. 307 * `POST /containers/create` now accepts a `fluentd-request-ack` option in 308 `HostConfig.LogConfig.Config` when using the Fluentd logging driver. If enabled, 309 the Fluentd logging driver sends the chunk option with a unique ID. The server 310 will respond with an acknowledgement. This option improves the reliability of 311 the message transmission. This change is not versioned, and affects all API 312 versions if the daemon has this patch. 313 * `POST /containers/create`, `GET /containers/{id}/json`, and `GET /containers/json` now supports 314 `BindOptions.NonRecursive`. 315 * `POST /swarm/init` now accepts a `DataPathPort` property to set data path port number. 316 * `GET /info` now returns information about `DataPathPort` that is currently used in swarm 317 * `GET /info` now returns `PidsLimit` boolean to indicate if the host kernel has 318 PID limit support enabled. 319 * `GET /info` now includes `name=rootless` in `SecurityOptions` when the daemon is running in 320 rootless mode. This change is not versioned, and affects all API versions if the daemon has 321 this patch. 322 * `GET /info` now returns `none` as `CgroupDriver` when the daemon is running in rootless mode. 323 This change is not versioned, and affects all API versions if the daemon has this patch. 324 * `POST /containers/create` now accepts `DeviceRequests` as part of `HostConfig`. 325 Can be used to set Nvidia GPUs. 326 * `GET /swarm` endpoint now returns DataPathPort info 327 * `POST /containers/create` now takes `KernelMemoryTCP` field to set hard limit for kernel TCP buffer memory. 328 * `GET /service` now returns `MaxReplicas` as part of the `Placement`. 329 * `GET /service/{id}` now returns `MaxReplicas` as part of the `Placement`. 330 * `POST /service/create` and `POST /services/(id or name)/update` now take the field `MaxReplicas` 331 as part of the service `Placement`, allowing to specify maximum replicas per node for the service. 332 * `POST /containers/create` on Linux now creates a container with `HostConfig.IpcMode=private` 333 by default, if IpcMode is not explicitly specified. The per-daemon default can be changed 334 back to `shareable` by using `DefaultIpcMode` daemon configuration parameter. 335 * `POST /containers/{id}/update` now accepts a `PidsLimit` field to tune a container's 336 PID limit. Set `0` or `-1` for unlimited. Leave `null` to not change the current value. 337 * `POST /build` now accepts `outputs` key for configuring build outputs when using BuildKit mode. 338 339 ## V1.39 API changes 340 341 [Docker Engine API v1.39](https://docs.docker.com/engine/api/v1.39/) documentation 342 343 * `GET /info` now returns an empty string, instead of `<unknown>` for `KernelVersion` 344 and `OperatingSystem` if the daemon was unable to obtain this information. 345 * `GET /info` now returns information about the product license, if a license 346 has been applied to the daemon. 347 * `GET /info` now returns a `Warnings` field, containing warnings and informational 348 messages about missing features, or issues related to the daemon configuration. 349 * `POST /swarm/init` now accepts a `DefaultAddrPool` property to set global scope default address pool 350 * `POST /swarm/init` now accepts a `SubnetSize` property to set global scope networks by giving the 351 length of the subnet masks for every such network 352 * `POST /session` (added in [V1.31](#v131-api-changes) is no longer experimental. 353 This endpoint can be used to run interactive long-running protocols between the 354 client and the daemon. 355 356 ## V1.38 API changes 357 358 [Docker Engine API v1.38](https://docs.docker.com/engine/api/v1.38/) documentation 359 360 361 * `GET /tasks` and `GET /tasks/{id}` now return a `NetworkAttachmentSpec` field, 362 containing the `ContainerID` for non-service containers connected to "attachable" 363 swarm-scoped networks. 364 365 ## v1.37 API changes 366 367 [Docker Engine API v1.37](https://docs.docker.com/engine/api/v1.37/) documentation 368 369 * `POST /containers/create` and `POST /services/create` now supports exposing SCTP ports. 370 * `POST /configs/create` and `POST /configs/{id}/create` now accept a `Templating` driver. 371 * `GET /configs` and `GET /configs/{id}` now return the `Templating` driver of the config. 372 * `POST /secrets/create` and `POST /secrets/{id}/create` now accept a `Templating` driver. 373 * `GET /secrets` and `GET /secrets/{id}` now return the `Templating` driver of the secret. 374 375 ## v1.36 API changes 376 377 [Docker Engine API v1.36](https://docs.docker.com/engine/api/v1.36/) documentation 378 379 * `Get /events` now return `exec_die` event when an exec process terminates. 380 381 382 ## v1.35 API changes 383 384 [Docker Engine API v1.35](https://docs.docker.com/engine/api/v1.35/) documentation 385 386 * `POST /services/create` and `POST /services/(id)/update` now accepts an 387 `Isolation` field on container spec to set the Isolation technology of the 388 containers running the service (`default`, `process`, or `hyperv`). This 389 configuration is only used for Windows containers. 390 * `GET /containers/(name)/logs` now supports an additional query parameter: `until`, 391 which returns log lines that occurred before the specified timestamp. 392 * `POST /containers/{id}/exec` now accepts a `WorkingDir` property to set the 393 work-dir for the exec process, independent of the container's work-dir. 394 * `Get /version` now returns a `Platform.Name` field, which can be used by products 395 using Moby as a foundation to return information about the platform. 396 * `Get /version` now returns a `Components` field, which can be used to return 397 information about the components used. Information about the engine itself is 398 now included as a "Component" version, and contains all information from the 399 top-level `Version`, `GitCommit`, `APIVersion`, `MinAPIVersion`, `GoVersion`, 400 `Os`, `Arch`, `BuildTime`, `KernelVersion`, and `Experimental` fields. Going 401 forward, the information from the `Components` section is preferred over their 402 top-level counterparts. 403 404 405 ## v1.34 API changes 406 407 [Docker Engine API v1.34](https://docs.docker.com/engine/api/v1.34/) documentation 408 409 * `POST /containers/(name)/wait?condition=removed` now also also returns 410 in case of container removal failure. A pointer to a structure named 411 `Error` added to the response JSON in order to indicate a failure. 412 If `Error` is `null`, container removal has succeeded, otherwise 413 the test of an error message indicating why container removal has failed 414 is available from `Error.Message` field. 415 416 ## v1.33 API changes 417 418 [Docker Engine API v1.33](https://docs.docker.com/engine/api/v1.33/) documentation 419 420 * `GET /events` now supports filtering 4 more kinds of events: `config`, `node`, 421 `secret` and `service`. 422 423 ## v1.32 API changes 424 425 [Docker Engine API v1.32](https://docs.docker.com/engine/api/v1.32/) documentation 426 427 * `POST /images/create` now accepts a `platform` parameter in the form of `os[/arch[/variant]]`. 428 * `POST /containers/create` now accepts additional values for the 429 `HostConfig.IpcMode` property. New values are `private`, `shareable`, 430 and `none`. 431 * `DELETE /networks/{id or name}` fixed issue where a `name` equal to another 432 network's name was able to mask that `id`. If both a network with the given 433 _name_ exists, and a network with the given _id_, the network with the given 434 _id_ is now deleted. This change is not versioned, and affects all API versions 435 if the daemon has this patch. 436 437 ## v1.31 API changes 438 439 [Docker Engine API v1.31](https://docs.docker.com/engine/api/v1.31/) documentation 440 441 * `DELETE /secrets/(name)` now returns status code 404 instead of 500 when the secret does not exist. 442 * `POST /secrets/create` now returns status code 409 instead of 500 when creating an already existing secret. 443 * `POST /secrets/create` now accepts a `Driver` struct, allowing the 444 `Name` and driver-specific `Options` to be passed to store a secrets 445 in an external secrets store. The `Driver` property can be omitted 446 if the default (internal) secrets store is used. 447 * `GET /secrets/(id)` and `GET /secrets` now return a `Driver` struct, 448 containing the `Name` and driver-specific `Options` of the external 449 secrets store used to store the secret. The `Driver` property is 450 omitted if no external store is used. 451 * `POST /secrets/(name)/update` now returns status code 400 instead of 500 when updating a secret's content which is not the labels. 452 * `POST /nodes/(name)/update` now returns status code 400 instead of 500 when demoting last node fails. 453 * `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`). 454 * `POST /session` is a new endpoint that can be used for running interactive long-running protocols between client and 455 the daemon. This endpoint is experimental and only available if the daemon is started with experimental features 456 enabled. 457 * `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. 458 * `POST /services/create` now accepts a `PluginSpec` when `TaskTemplate.Runtime` is set to `plugin` 459 * `GET /events` now supports config events `create`, `update` and `remove` that are emitted when users create, update or remove a config 460 * `GET /volumes/` and `GET /volumes/{name}` now return a `CreatedAt` field, 461 containing the date/time the volume was created. This field is omitted if the 462 creation date/time for the volume is unknown. For volumes with scope "global", 463 this field represents the creation date/time of the local _instance_ of the 464 volume, which may differ from instances of the same volume on different nodes. 465 * `GET /system/df` now returns a `CreatedAt` field for `Volumes`. Refer to the 466 `/volumes/` endpoint for a description of this field. 467 468 ## v1.30 API changes 469 470 [Docker Engine API v1.30](https://docs.docker.com/engine/api/v1.30/) documentation 471 472 * `GET /info` now returns the list of supported logging drivers, including plugins. 473 * `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 474 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. 475 * `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. 476 * `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 477 issuer's subject and public key. 478 * `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. 479 * `POST /swarm/update` now accepts 3 additional parameters as part of the swarm spec's CA configuration; the desired CA certificate for 480 the swarm, the desired CA key for the swarm (if not using an external certificate), and an optional parameter to force swarm to 481 generate and rotate to a new CA certificate/key pair. 482 * `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. 483 * `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. 484 * `POST /swarm/init` now accepts a `DataPathAddr` property to set the IP-address or network interface to use for data traffic 485 * `POST /swarm/join` now accepts a `DataPathAddr` property to set the IP-address or network interface to use for data traffic 486 * `GET /events` now supports service, node and secret events which are emitted when users create, update and remove service, node and secret 487 * `GET /events` now supports network remove event which is emitted when users remove a swarm scoped network 488 * `GET /events` now supports a filter type `scope` in which supported value could be swarm and local 489 * `PUT /containers/(name)/archive` now accepts a `copyUIDGID` parameter to allow copy UID/GID maps to dest file or dir. 490 491 ## v1.29 API changes 492 493 [Docker Engine API v1.29](https://docs.docker.com/engine/api/v1.29/) documentation 494 495 * `DELETE /networks/(name)` now allows to remove the ingress network, the one used to provide the routing-mesh. 496 * `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. 497 * `GET /networks/(name)` now returns an `Ingress` field showing whether the network is the ingress one. 498 * `GET /networks/` now supports a `scope` filter to filter networks based on the network mode (`swarm`, `global`, or `local`). 499 * `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. 500 * `GET /services/(id)` now accepts an `insertDefaults` query-parameter to merge default values into the service inspect output. 501 * `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. 502 * `POST /services/create` now accepts `Privileges` as part of `ContainerSpec`. Privileges currently include 503 `CredentialSpec` and `SELinuxContext`. 504 505 ## v1.28 API changes 506 507 [Docker Engine API v1.28](https://docs.docker.com/engine/api/v1.28/) documentation 508 509 * `POST /containers/create` now includes a `Consistency` field to specify the consistency level for each `Mount`, with possible values `default`, `consistent`, `cached`, or `delegated`. 510 * `GET /containers/create` now takes a `DeviceCgroupRules` field in `HostConfig` allowing to set custom device cgroup rules for the created container. 511 * 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. 512 * `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. 513 * `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}`. 514 * `GET /containers/json` now supports `publish` and `expose` filters to filter containers that expose or publish certain ports. 515 * `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. 516 * `POST /build` now accepts `extrahosts` parameter to specify a host to ip mapping to use during the build. 517 * `POST /services/create` and `POST /services/(id or name)/update` now accept a `rollback` value for `FailureAction`. 518 * `POST /services/create` and `POST /services/(id or name)/update` now accept an optional `RollbackConfig` object which specifies rollback options. 519 * `GET /services` now supports a `mode` filter to filter services based on the service mode (either `global` or `replicated`). 520 * `POST /containers/(name)/update` now supports updating `NanoCpus` that represents CPU quota in units of 10<sup>-9</sup> CPUs. 521 * `POST /plugins/{name}/disable` now accepts a `force` query-parameter to disable a plugin even if still in use. 522 523 ## v1.27 API changes 524 525 [Docker Engine API v1.27](https://docs.docker.com/engine/api/v1.27/) documentation 526 527 * `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. 528 529 ## v1.26 API changes 530 531 [Docker Engine API v1.26](https://docs.docker.com/engine/api/v1.26/) documentation 532 533 * `POST /plugins/(plugin name)/upgrade` upgrade a plugin. 534 535 ## v1.25 API changes 536 537 [Docker Engine API v1.25](https://docs.docker.com/engine/api/v1.25/) documentation 538 539 * 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`. 540 * `GET /version` now returns `MinAPIVersion`. 541 * `POST /build` accepts `networkmode` parameter to specify network used during build. 542 * `GET /images/(name)/json` now returns `OsVersion` if populated 543 * `GET /images/(name)/json` no longer contains the `RootFS.BaseLayer` field. This 544 field was used for Windows images that used a base-image that was pre-installed 545 on the host (`RootFS.Type` `layers+base`), which is no longer supported, and 546 the `RootFS.BaseLayer` field has been removed. 547 * `GET /info` now returns `Isolation`. 548 * `POST /containers/create` now takes `AutoRemove` in HostConfig, to enable auto-removal of the container on daemon side when the container's process exits. 549 * `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. 550 * `GET /containers/json` now accepts `removing` as a valid value for the `status` filter. 551 * `GET /containers/json` now supports filtering containers by `health` status. 552 * `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. 553 * `POST /containers/create/` and `POST /containers/(name)/update` now validates restart policies. 554 * `POST /containers/create` now validates IPAMConfig in NetworkingConfig, and returns error for invalid IPv4 and IPv6 addresses (`--ip` and `--ip6` in `docker create/run`). 555 * `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`. 556 * `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. 557 * `POST /build` accepts `cachefrom` parameter to specify images used for build cache. 558 * `GET /networks/` endpoint now correctly returns a list of *all* networks, 559 instead of the default network if a trailing slash is provided, but no `name` 560 or `id`. 561 * `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. 562 * `GET /containers/json` now supports a `is-task` filter to filter 563 containers that are tasks (part of a service in swarm mode). 564 * `POST /containers/create` now takes `StopTimeout` field. 565 * `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. 566 * `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. 567 * `POST /services/create` and `POST /services/(id or name)/update` now return a `Warnings` array. 568 * `GET /networks/(name)` now returns field `Created` in response to show network created time. 569 * `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. 570 * `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. 571 * `GET /exec/(id)/json` now returns `Pid`, which is the system pid for the exec'd process. 572 * `POST /containers/prune` prunes stopped containers. 573 * `POST /images/prune` prunes unused images. 574 * `POST /volumes/prune` prunes unused volumes. 575 * `POST /networks/prune` prunes unused networks. 576 * Every API response now includes a `Docker-Experimental` header specifying if experimental features are enabled (value can be `true` or `false`). 577 * Every API response now includes a `API-Version` header specifying the default API version of the server. 578 * 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. 579 * The `SecurityOptions` field within the `GET /info` response now includes `userns` if user namespaces are enabled in the daemon. 580 * `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. 581 * The `HostConfig` field now includes `NanoCpus` that represents CPU quota in units of 10<sup>-9</sup> CPUs. 582 * `GET /info` now returns more structured information about security options. 583 * The `HostConfig` field now includes `CpuCount` that represents the number of CPUs available for execution by the container. Windows daemon only. 584 * `POST /services/create` and `POST /services/(id or name)/update` now accept the `TTY` parameter, which allocate a pseudo-TTY in container. 585 * `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`. 586 * `POST /services/create` and `POST /services/(id or name)/update` now support 587 `node.platform.arch` and `node.platform.os` constraints in the services 588 `TaskSpec.Placement.Constraints` field. 589 * `GET /networks/(id or name)` now includes IP and name of all peers nodes for swarm mode overlay networks. 590 * `GET /plugins` list plugins. 591 * `POST /plugins/pull?name=<plugin name>` pulls a plugin. 592 * `GET /plugins/(plugin name)` inspect a plugin. 593 * `POST /plugins/(plugin name)/set` configure a plugin. 594 * `POST /plugins/(plugin name)/enable` enable a plugin. 595 * `POST /plugins/(plugin name)/disable` disable a plugin. 596 * `POST /plugins/(plugin name)/push` push a plugin. 597 * `POST /plugins/create?name=(plugin name)` create a plugin. 598 * `DELETE /plugins/(plugin name)` delete a plugin. 599 * `POST /node/(id or name)/update` now accepts both `id` or `name` to identify the node to update. 600 * `GET /images/json` now support a `reference` filter. 601 * `GET /secrets` returns information on the secrets. 602 * `POST /secrets/create` creates a secret. 603 * `DELETE /secrets/{id}` removes the secret `id`. 604 * `GET /secrets/{id}` returns information on the secret `id`. 605 * `POST /secrets/{id}/update` updates the secret `id`. 606 * `POST /services/(id or name)/update` now accepts service name or prefix of service id as a parameter. 607 * `POST /containers/create` added 2 built-in log-opts that work on all logging drivers, 608 `mode` (`blocking`|`non-blocking`), and `max-buffer-size` (e.g. `2m`) which enables a non-blocking log buffer. 609 * `POST /containers/create` now takes `HostConfig.Init` field to run an init 610 inside the container that forwards signals and reaps processes. 611 612 ## v1.24 API changes 613 614 [Docker Engine API v1.24](v1.24.md) documentation 615 616 * `POST /containers/create` now takes `StorageOpt` field. 617 * `GET /info` now returns `SecurityOptions` field, showing if `apparmor`, `seccomp`, or `selinux` is supported. 618 * `GET /info` no longer returns the `ExecutionDriver` property. This property was no longer used after integration 619 with ContainerD in Docker 1.11. 620 * `GET /networks` now supports filtering by `label` and `driver`. 621 * `GET /containers/json` now supports filtering containers by `network` name or id. 622 * `POST /containers/create` now takes `IOMaximumBandwidth` and `IOMaximumIOps` fields. Windows daemon only. 623 * `POST /containers/create` now returns an HTTP 400 "bad parameter" message 624 if no command is specified (instead of an HTTP 500 "server error") 625 * `GET /images/search` now takes a `filters` query parameter. 626 * `GET /events` now supports a `reload` event that is emitted when the daemon configuration is reloaded. 627 * `GET /events` now supports filtering by daemon name or ID. 628 * `GET /events` now supports a `detach` event that is emitted on detaching from container process. 629 * `GET /events` now supports an `exec_detach ` event that is emitted on detaching from exec process. 630 * `GET /images/json` now supports filters `since` and `before`. 631 * `POST /containers/(id or name)/start` no longer accepts a `HostConfig`. 632 * `POST /images/(name)/tag` no longer has a `force` query parameter. 633 * `GET /images/search` now supports maximum returned search results `limit`. 634 * `POST /containers/{name:.*}/copy` is now removed and errors out starting from this API version. 635 * API errors are now returned as JSON instead of plain text. 636 * `POST /containers/create` and `POST /containers/(id)/start` allow you to configure kernel parameters (sysctls) for use in the container. 637 * `POST /containers/<container ID>/exec` and `POST /exec/<exec ID>/start` 638 no longer expects a "Container" field to be present. This property was not used 639 and is no longer sent by the docker client. 640 * `POST /containers/create/` now validates the hostname (should be a valid RFC 1123 hostname). 641 * `POST /containers/create/` `HostConfig.PidMode` field now accepts `container:<name|id>`, 642 to have the container join the PID namespace of an existing container. 643 644 ## v1.23 API changes 645 646 [Docker Engine API v1.23](v1.23.md) documentation 647 648 * `GET /containers/json` returns the state of the container, one of `created`, `restarting`, `running`, `paused`, `exited` or `dead`. 649 * `GET /containers/json` returns the mount points for the container. 650 * `GET /networks/(name)` now returns an `Internal` field showing whether the network is internal or not. 651 * `GET /networks/(name)` now returns an `EnableIPv6` field showing whether the network has ipv6 enabled or not. 652 * `POST /containers/(name)/update` now supports updating container's restart policy. 653 * `POST /networks/create` now supports enabling ipv6 on the network by setting the `EnableIPv6` field (doing this with a label will no longer work). 654 * `GET /info` now returns `CgroupDriver` field showing what cgroup driver the daemon is using; `cgroupfs` or `systemd`. 655 * `GET /info` now returns `KernelMemory` field, showing if "kernel memory limit" is supported. 656 * `POST /containers/create` now takes `PidsLimit` field, if the kernel is >= 4.3 and the pids cgroup is supported. 657 * `GET /containers/(id or name)/stats` now returns `pids_stats`, if the kernel is >= 4.3 and the pids cgroup is supported. 658 * `POST /containers/create` now allows you to override usernamespaces remapping and use privileged options for the container. 659 * `POST /containers/create` now allows specifying `nocopy` for named volumes, which disables automatic copying from the container path to the volume. 660 * `POST /auth` now returns an `IdentityToken` when supported by a registry. 661 * `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`. 662 * `GET /volumes` now supports more filters, new added filters are `name` and `driver`. 663 * `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. 664 * `POST /images/load` now returns progress information as a JSON stream, and has a `quiet` query parameter to suppress progress details. 665 666 ## v1.22 API changes 667 668 [Docker Engine API v1.22](v1.22.md) documentation 669 670 * The `HostConfig.LxcConf` field has been removed, and is no longer available on 671 `POST /containers/create` and `GET /containers/(id)/json`. 672 * `POST /container/(name)/update` updates the resources of a container. 673 * `GET /containers/json` supports filter `isolation` on Windows. 674 * `GET /containers/json` now returns the list of networks of containers. 675 * `GET /info` Now returns `Architecture` and `OSType` fields, providing information 676 about the host architecture and operating system type that the daemon runs on. 677 * `GET /networks/(name)` now returns a `Name` field for each container attached to the network. 678 * `GET /version` now returns the `BuildTime` field in RFC3339Nano format to make it 679 consistent with other date/time values returned by the API. 680 * `AuthConfig` now supports a `registrytoken` for token based authentication 681 * `POST /containers/create` now has a 4M minimum value limit for `HostConfig.KernelMemory` 682 * Pushes initiated with `POST /images/(name)/push` and pulls initiated with `POST /images/create` 683 will be cancelled if the HTTP connection making the API request is closed before 684 the push or pull completes. 685 * `POST /containers/create` now allows you to set a read/write rate limit for a 686 device (in bytes per second or IO per second). 687 * `GET /networks` now supports filtering by `name`, `id` and `type`. 688 * `POST /containers/create` now allows you to set the static IPv4 and/or IPv6 address for the container. 689 * `POST /networks/(id)/connect` now allows you to set the static IPv4 and/or IPv6 address for the container. 690 * `GET /info` now includes the number of containers running, stopped, and paused. 691 * `POST /networks/create` now supports restricting external access to the network by setting the `Internal` field. 692 * `POST /networks/(id)/disconnect` now includes a `Force` option to forcefully disconnect a container from network 693 * `GET /containers/(id)/json` now returns the `NetworkID` of containers. 694 * `POST /networks/create` Now supports an options field in the IPAM config that provides options 695 for custom IPAM plugins. 696 * `GET /networks/{network-id}` Now returns IPAM config options for custom IPAM plugins if any 697 are available. 698 * `GET /networks/<network-id>` now returns subnets info for user-defined networks. 699 * `GET /info` can now return a `SystemStatus` field useful for returning additional information about applications 700 that are built on top of engine. 701 702 ## v1.21 API changes 703 704 [Docker Engine API v1.21](v1.21.md) documentation 705 706 * `GET /volumes` lists volumes from all volume drivers. 707 * `POST /volumes/create` to create a volume. 708 * `GET /volumes/(name)` get low-level information about a volume. 709 * `DELETE /volumes/(name)` remove a volume with the specified name. 710 * `VolumeDriver` was moved from `config` to `HostConfig` to make the configuration portable. 711 * `GET /images/(name)/json` now returns information about an image's `RepoTags` and `RepoDigests`. 712 * The `config` option now accepts the field `StopSignal`, which specifies the signal to use to kill a container. 713 * `GET /containers/(id)/stats` will return networking information respectively for each interface. 714 * The `HostConfig` option now includes the `DnsOptions` field to configure the container's DNS options. 715 * `POST /build` now optionally takes a serialized map of build-time variables. 716 * `GET /events` now includes a `timenano` field, in addition to the existing `time` field. 717 * `GET /events` now supports filtering by image and container labels. 718 * `GET /info` now lists engine version information and return the information of `CPUShares` and `Cpuset`. 719 * `GET /containers/json` will return `ImageID` of the image used by container. 720 * `POST /exec/(name)/start` will now return an HTTP 409 when the container is either stopped or paused. 721 * `POST /containers/create` now takes `KernelMemory` in HostConfig to specify kernel memory limit. 722 * `GET /containers/(name)/json` now accepts a `size` parameter. Setting this parameter to '1' returns container size information in the `SizeRw` and `SizeRootFs` fields. 723 * `GET /containers/(name)/json` now returns a `NetworkSettings.Networks` field, 724 detailing network settings per network. This field deprecates the 725 `NetworkSettings.Gateway`, `NetworkSettings.IPAddress`, 726 `NetworkSettings.IPPrefixLen`, and `NetworkSettings.MacAddress` fields, which 727 are still returned for backward-compatibility, but will be removed in a future version. 728 * `GET /exec/(id)/json` now returns a `NetworkSettings.Networks` field, 729 detailing networksettings per network. This field deprecates the 730 `NetworkSettings.Gateway`, `NetworkSettings.IPAddress`, 731 `NetworkSettings.IPPrefixLen`, and `NetworkSettings.MacAddress` fields, which 732 are still returned for backward-compatibility, but will be removed in a future version. 733 * The `HostConfig` option now includes the `OomScoreAdj` field for adjusting the 734 badness heuristic. This heuristic selects which processes the OOM killer kills 735 under out-of-memory conditions. 736 737 ## v1.20 API changes 738 739 [Docker Engine API v1.20](v1.20.md) documentation 740 741 * `GET /containers/(id)/archive` get an archive of filesystem content from a container. 742 * `PUT /containers/(id)/archive` upload an archive of content to be extracted to 743 an existing directory inside a container's filesystem. 744 * `POST /containers/(id)/copy` is deprecated in favor of the above `archive` 745 endpoint which can be used to download files and directories from a container. 746 * The `hostConfig` option now accepts the field `GroupAdd`, which specifies a 747 list of additional groups that the container process will run as. 748 749 ## v1.19 API changes 750 751 [Docker Engine API v1.19](v1.19.md) documentation 752 753 * When the daemon detects a version mismatch with the client, usually when 754 the client is newer than the daemon, an HTTP 400 is now returned instead 755 of a 404. 756 * `GET /containers/(id)/stats` now accepts `stream` bool to get only one set of stats and disconnect. 757 * `GET /containers/(id)/logs` now accepts a `since` timestamp parameter. 758 * `GET /info` The fields `Debug`, `IPv4Forwarding`, `MemoryLimit`, and 759 `SwapLimit` are now returned as boolean instead of as an int. In addition, the 760 end point now returns the new boolean fields `CpuCfsPeriod`, `CpuCfsQuota`, and 761 `OomKillDisable`. 762 * The `hostConfig` option now accepts the fields `CpuPeriod` and `CpuQuota` 763 * `POST /build` accepts `cpuperiod` and `cpuquota` options 764 765 ## v1.18 API changes 766 767 [Docker Engine API v1.18](v1.18.md) documentation 768 769 * `GET /version` now returns `Os`, `Arch` and `KernelVersion`. 770 * `POST /containers/create` and `POST /containers/(id)/start`allow you to set ulimit settings for use in the container. 771 * `GET /info` now returns `SystemTime`, `HttpProxy`,`HttpsProxy` and `NoProxy`. 772 * `GET /images/json` added a `RepoDigests` field to include image digest information. 773 * `POST /build` can now set resource constraints for all containers created for the build. 774 * `CgroupParent` can be passed in the host config to setup container cgroups under a specific cgroup. 775 * `POST /build` closing the HTTP request cancels the build 776 * `POST /containers/(id)/exec` includes `Warnings` field to response.