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