|
@@ -2489,22 +2489,23 @@ paths:
|
|
- name: "filters"
|
|
- name: "filters"
|
|
in: "query"
|
|
in: "query"
|
|
description: |
|
|
description: |
|
|
- Filters to process on the container list, encoded as JSON (a `map[string][]string`). For example, `{"status": ["paused"]}` will only return paused containers.
|
|
|
|
|
|
+ Filters to process on the container list, encoded as JSON (a `map[string][]string`). For example, `{"status": ["paused"]}` will only return paused containers. Available filters:
|
|
|
|
|
|
- Available filters:
|
|
|
|
|
|
+ - `ancestor`=(`<image-name>[:<tag>]`, `<image id>`, or `<image@digest>`)
|
|
|
|
+ - `before`=(`<container id>` or `<container name>`)
|
|
|
|
+ - `expose`=(`<port>[/<proto>]`|`<startport-endport>/[<proto>]`)
|
|
- `exited=<int>` containers with exit code of `<int>`
|
|
- `exited=<int>` containers with exit code of `<int>`
|
|
- - `status=`(`created`|`restarting`|`running`|`removing`|`paused`|`exited`|`dead`)
|
|
|
|
- - `label=key` or `label="key=value"` of a container label
|
|
|
|
- - `isolation=`(`default`|`process`|`hyperv`) (Windows daemon only)
|
|
|
|
|
|
+ - `health`=(`starting`|`healthy`|`unhealthy`|`none`)
|
|
- `id=<ID>` a container's ID
|
|
- `id=<ID>` a container's ID
|
|
- - `name=<name>` a container's name
|
|
|
|
|
|
+ - `isolation=`(`default`|`process`|`hyperv`) (Windows daemon only)
|
|
- `is-task=`(`true`|`false`)
|
|
- `is-task=`(`true`|`false`)
|
|
- - `ancestor`=(`<image-name>[:<tag>]`, `<image id>`, or `<image@digest>`)
|
|
|
|
- - `before`=(`<container id>` or `<container name>`)
|
|
|
|
|
|
+ - `label=key` or `label="key=value"` of a container label
|
|
|
|
+ - `name=<name>` a container's name
|
|
|
|
+ - `network`=(`<network id>` or `<network name>`)
|
|
|
|
+ - `publish`=(`<port>[/<proto>]`|`<startport-endport>/[<proto>]`)
|
|
- `since`=(`<container id>` or `<container name>`)
|
|
- `since`=(`<container id>` or `<container name>`)
|
|
|
|
+ - `status=`(`created`|`restarting`|`running`|`removing`|`paused`|`exited`|`dead`)
|
|
- `volume`=(`<volume name>` or `<mount point destination>`)
|
|
- `volume`=(`<volume name>` or `<mount point destination>`)
|
|
- - `network`=(`<network id>` or `<network name>`)
|
|
|
|
- - `health`=(`starting`|`healthy`|`unhealthy`|`none`)
|
|
|
|
type: "string"
|
|
type: "string"
|
|
responses:
|
|
responses:
|
|
200:
|
|
200:
|
|
@@ -4310,14 +4311,13 @@ paths:
|
|
- name: "filters"
|
|
- name: "filters"
|
|
in: "query"
|
|
in: "query"
|
|
description: |
|
|
description: |
|
|
- A JSON encoded value of the filters (a `map[string][]string`) to process on the images list.
|
|
|
|
|
|
+ A JSON encoded value of the filters (a `map[string][]string`) to process on the images list. Available filters:
|
|
|
|
|
|
- Available filters:
|
|
|
|
|
|
+ - `before`=(`<image-name>[:<tag>]`, `<image id>` or `<image@digest>`)
|
|
- `dangling=true`
|
|
- `dangling=true`
|
|
- `label=key` or `label="key=value"` of an image label
|
|
- `label=key` or `label="key=value"` of an image label
|
|
- - `before`=(`<image-name>[:<tag>]`, `<image id>` or `<image@digest>`)
|
|
|
|
- - `since`=(`<image-name>[:<tag>]`, `<image id>` or `<image@digest>`)
|
|
|
|
- `reference`=(`<image-name>[:<tag>]`)
|
|
- `reference`=(`<image-name>[:<tag>]`)
|
|
|
|
+ - `since`=(`<image-name>[:<tag>]`, `<image id>` or `<image@digest>`)
|
|
type: "string"
|
|
type: "string"
|
|
- name: "digests"
|
|
- name: "digests"
|
|
in: "query"
|
|
in: "query"
|
|
@@ -4899,9 +4899,9 @@ paths:
|
|
description: |
|
|
description: |
|
|
A JSON encoded value of the filters (a `map[string][]string`) to process on the images list. Available filters:
|
|
A JSON encoded value of the filters (a `map[string][]string`) to process on the images list. Available filters:
|
|
|
|
|
|
- - `stars=<number>`
|
|
|
|
- `is-automated=(true|false)`
|
|
- `is-automated=(true|false)`
|
|
- `is-official=(true|false)`
|
|
- `is-official=(true|false)`
|
|
|
|
+ - `stars=<number>` Matches images that has at least 'number' stars.
|
|
type: "string"
|
|
type: "string"
|
|
tags: ["Image"]
|
|
tags: ["Image"]
|
|
/images/prune:
|
|
/images/prune:
|
|
@@ -4914,9 +4914,8 @@ paths:
|
|
- name: "filters"
|
|
- name: "filters"
|
|
in: "query"
|
|
in: "query"
|
|
description: |
|
|
description: |
|
|
- Filters to process on the prune list, encoded as JSON (a `map[string][]string`).
|
|
|
|
|
|
+ Filters to process on the prune list, encoded as JSON (a `map[string][]string`). Available filters:
|
|
|
|
|
|
- Available filters:
|
|
|
|
- `dangling=<boolean>` When set to `true` (or `1`), prune only
|
|
- `dangling=<boolean>` When set to `true` (or `1`), prune only
|
|
unused *and* untagged images. When set to `false`
|
|
unused *and* untagged images. When set to `false`
|
|
(or `0`), all unused images are pruned.
|
|
(or `0`), all unused images are pruned.
|
|
@@ -5411,13 +5410,14 @@ paths:
|
|
A JSON encoded value of filters (a `map[string][]string`) to process on the event list. Available filters:
|
|
A JSON encoded value of filters (a `map[string][]string`) to process on the event list. Available filters:
|
|
|
|
|
|
- `container=<string>` container name or ID
|
|
- `container=<string>` container name or ID
|
|
|
|
+ - `daemon=<string>` daemon name or ID
|
|
- `event=<string>` event type
|
|
- `event=<string>` event type
|
|
- `image=<string>` image name or ID
|
|
- `image=<string>` image name or ID
|
|
- `label=<string>` image or container label
|
|
- `label=<string>` image or container label
|
|
|
|
+ - `network=<string>` network name or ID
|
|
|
|
+ - `plugin`=<string> plugin name or ID
|
|
- `type=<string>` object to filter by, one of `container`, `image`, `volume`, `network`, or `daemon`
|
|
- `type=<string>` object to filter by, one of `container`, `image`, `volume`, `network`, or `daemon`
|
|
- `volume=<string>` volume name or ID
|
|
- `volume=<string>` volume name or ID
|
|
- - `network=<string>` network name or ID
|
|
|
|
- - `daemon=<string>` daemon name or ID
|
|
|
|
type: "string"
|
|
type: "string"
|
|
tags: ["System"]
|
|
tags: ["System"]
|
|
/system/df:
|
|
/system/df:
|
|
@@ -5891,13 +5891,14 @@ paths:
|
|
JSON encoded value of the filters (a `map[string][]string`) to
|
|
JSON encoded value of the filters (a `map[string][]string`) to
|
|
process on the volumes list. Available filters:
|
|
process on the volumes list. Available filters:
|
|
|
|
|
|
- - `name=<volume-name>` Matches all or part of a volume name.
|
|
|
|
- `dangling=<boolean>` When set to `true` (or `1`), returns all
|
|
- `dangling=<boolean>` When set to `true` (or `1`), returns all
|
|
volumes that are not in use by a container. When set to `false`
|
|
volumes that are not in use by a container. When set to `false`
|
|
(or `0`), only volumes that are in use by one or more
|
|
(or `0`), only volumes that are in use by one or more
|
|
containers are returned.
|
|
containers are returned.
|
|
- - `driver=<volume-driver-name>` Matches all or part of a volume
|
|
|
|
- driver name.
|
|
|
|
|
|
+ - `driver=<volume-driver-name>` Matches volumes based on their driver.
|
|
|
|
+ - `label=<key>` or `label=<key>:<value>` Matches volumes based on
|
|
|
|
+ the presence of a `label` alone or a `label` and a value.
|
|
|
|
+ - `name=<volume-name>` Matches all or part of a volume name.
|
|
type: "string"
|
|
type: "string"
|
|
format: "json"
|
|
format: "json"
|
|
tags: ["Volume"]
|
|
tags: ["Volume"]
|
|
@@ -7264,8 +7265,8 @@ paths:
|
|
A JSON encoded value of the filters (a `map[string][]string`) to process on the services list. Available filters:
|
|
A JSON encoded value of the filters (a `map[string][]string`) to process on the services list. Available filters:
|
|
|
|
|
|
- `id=<service id>`
|
|
- `id=<service id>`
|
|
- - `name=<service name>`
|
|
|
|
- `label=<service label>`
|
|
- `label=<service label>`
|
|
|
|
+ - `name=<service name>`
|
|
tags: ["Service"]
|
|
tags: ["Service"]
|
|
/services/create:
|
|
/services/create:
|
|
post:
|
|
post:
|
|
@@ -7728,12 +7729,12 @@ paths:
|
|
description: |
|
|
description: |
|
|
A JSON encoded value of the filters (a `map[string][]string`) to process on the tasks list. Available filters:
|
|
A JSON encoded value of the filters (a `map[string][]string`) to process on the tasks list. Available filters:
|
|
|
|
|
|
|
|
+ - `desired-state=(running | shutdown | accepted)`
|
|
- `id=<task id>`
|
|
- `id=<task id>`
|
|
|
|
+ - `label=key` or `label="key=value"`
|
|
- `name=<task name>`
|
|
- `name=<task name>`
|
|
- - `service=<service name>`
|
|
|
|
- `node=<node id or name>`
|
|
- `node=<node id or name>`
|
|
- - `label=key` or `label="key=value"`
|
|
|
|
- - `desired-state=(running | shutdown | accepted)`
|
|
|
|
|
|
+ - `service=<service name>`
|
|
tags: ["Task"]
|
|
tags: ["Task"]
|
|
/tasks/{id}:
|
|
/tasks/{id}:
|
|
get:
|
|
get:
|