Skip to content

Commit 2eadd58

Browse files
committed
Merge pull request #569 from docker/docs_filters
Improved filters documentation
2 parents 5eeb61a + eeb4d4a commit 2eadd58

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

docs/api.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -135,6 +135,10 @@ non-running ones
135135
non-running ones
136136
* limit (int): Show `limit` last created containers, include non-running ones
137137
* size (bool): Display sizes
138+
* filters (dict): Filters to be processed on the image list. Available filters:
139+
- `exited` (int): Only containers with specified exit code
140+
- `status` (str): One of `restarting`, `running`, `paused`, `exited`
141+
138142

139143
**Returns** (dict): The system's containers
140144

@@ -355,11 +359,12 @@ List images. Identical to the `docker images` command.
355359

356360
**Params**:
357361

358-
* name (str): Optional filter for a name
362+
* name (str): Only show images belonging to the repository `name`
359363
* quiet (bool): Only show numeric Ids. Returns a list
360364
* all (bool): Show all images (by default filter out the intermediate image
361365
layers)
362-
* viz: *Depreciated*
366+
* filters (dict): Filters to be processed on the image list. Available filters:
367+
- `dangling` (bool)
363368

364369
**Returns** (dict or list): A list if `quiet=True`, otherwise a dict.
365370

0 commit comments

Comments
 (0)