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