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