Both the GET /images
and GET
/images/detail
requests take query parameters that
serve to filter the returned list of images. The following list
details these query parameters.
name=NAME
Filters images having a
name
attribute matchingNAME
.container_format=FORMAT
Filters images having a
container_format
attribute matchingFORMAT
For more information, see :doc:`About Disk and Container Formats <formats>`
disk_format=FORMAT
Filters images having a
disk_format
attribute matchingFORMAT
For more information, see :doc:`About Disk and Container Formats <formats>`
status=STATUS
Filters images having a
status
attribute matchingSTATUS
For more information, see :doc:`About Image Statuses <statuses>`
size_min=BYTES
Filters images having a
size
attribute greater than or equal toBYTES
size_max=BYTES
Filters images having a
size
attribute less than or equal toBYTES
These two resources also accept sort parameters:
sort_key=KEY
Results will be ordered by the specified image attribute
KEY
. Accepted values includeid
,name
,status
,disk_format
,container_format
,size
,created_at
(default) andupdated_at
.sort_dir=DIR
Results will be sorted in the direction
DIR
. Accepted values areasc
for ascending ordesc
(default) for descending.