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