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