Listing Images

GET /v2/images

List virtual machine images.

info

Source: List Images (OpenStack Image API v2)

Request

Query parameters

Name	In	Type	Description
created_at (Optional)	query	string	Specify a comparison filter based on the date and time when the resource was created. Format: ISO 8601 (e.g. 2015-08-27T09:49:58-05:00). If time zone is omitted UTC is assumed.
limit (Optional)	query	integer	Requests a page size of items. Use with marker for pagination.
marker (Optional)	query	string	The ID of the last-seen item for pagination.
member_status (Optional)	query	string	Filters by member status. Valid values: accepted, pending, rejected, all. Default is accepted.
name (Optional)	query	string	Filter by image name.
os_hidden (Optional)	query	boolean	When true, include images marked as hidden. New in version 2.7.
owner (Optional)	query	string	Filter by project (tenant) ID; shows images shared by the specified owner.
protected (Optional)	query	boolean	Filter by protected property. Valid values: true, false. Any other value returns 400.
size_max (Optional)	query	string	Maximum image size (bytes).
size_min (Optional)	query	string	Minimum image size (bytes).
status (Optional)	query	integer	Filter by image status (e.g. active).
tag (Optional)	query	string	Filter by tag value. Can be repeated; queries are conjunctive (images must contain all specified tags).
updated_at (Optional)	query	string	Specify a comparison filter based on the date and time when the resource was last modified. Format: ISO 8601.
visibility (Optional)	query	string	Filter by visibility. Valid values: public, private, community, shared, all. If omitted, the response shows public, private, and shared images with member status accepted.
sort_dir (Optional)	query	string	Sort direction: asc or desc. Default direction is desc.
sort_key (Optional)	query	string	Sort by attribute (e.g. name, id, updated_at). Default is created_at.
sort (Optional)	query	string	Combined sort key and direction. Multiple pairs allowed, comma-separated. Example: sort=name:asc,status:desc.

Example request

Using curl

curl -ks -H 'Content-Type: application/json' \
  -H 'X-Auth-Token: gAAAAA<...>' \
  https://api.vietnix.cloud:9292/v2/images

Using HTTP request

GET https://api.vietnix.cloud:9292/v2/images

Response

Parameters

Name	Type	Description
images	array	A list of image objects.
first	string	The URI for the first page of response.
next	string	The URI for the next page of response. Not present on the last page.
schema	string	The URL for the schema describing a virtual machine image.

Common fields inside each image object:

Name	Type	Description
id	string	Image ID.
name	string	Human-readable image name.
status	string	Image status (e.g. active).
visibility	string	Visibility (public, private, shared, ...).
owner	string	Project (tenant) ID that owns the image.
size	integer	Image size in bytes.
min_ram	integer	Minimum RAM required (MB).
min_disk	integer	Minimum disk required (GB).
created_at	string	Creation time (ISO 8601).
updated_at	string	Last update time (ISO 8601) or null.
protected	boolean	Whether the image is protected.
tags	array	A list of tag strings.
checksum	string	Image checksum.
disk_format	string	Disk format (e.g. qcow2, raw).
container_format	string	Container format (e.g. bare).
os_type	string	OS type (e.g. linux, windows).
os_distro	string	OS distribution.
os_hash_algo	string	Hash algorithm used (e.g. sha512).
os_hash_value	string	Hash value.
file	string	URL path to the image file (relative to the API).
direct_url	string	Direct URL to the image file, if available.

Sample Response

{
    "images": [
        {
            "os_distro": "fedora42",
            "os_admin_user": "root",
            "hci_allow_set_password": "True",
            "image_validated": "yes",
            "name": "Fedora-42-x64",
            "disk_format": "qcow2",
            "container_format": "bare",
            "visibility": "public",
            "size": 2189361152,
            "virtual_size": 5368709120,
            "status": "active",
            "checksum": "b372bf54310cc7015035bb45f3867520",
            "protected": false,
            "min_ram": 0,
            "min_disk": 5,
            "owner": "a430f930af8e47d7a1820a477129c343",
            "os_hidden": false,
            "os_hash_algo": "sha512",
            "os_hash_value": "8d4281f665bce5594f7f485df224e21c48362d42019f2dfe17c1a4c9086dbfd43a8725cd06809d3582d30d88e887c6da623f8e16c211c242acf61d5bcfd6e6af",
            "id": "5f8ee89a-de28-4d4d-9a96-707b0393ee37",
            "created_at": "2025-10-02T08:30:39Z",
            "updated_at": "2025-10-02T08:44:31Z",
            "direct_url": "file:///mnt/vstorage/vols/datastores/glance/5f8ee89a-de28-4d4d-9a96-707b0393ee37",
            "tags": [],
            "self": "/v2/images/5f8ee89a-de28-4d4d-9a96-707b0393ee37",
            "file": "/v2/images/5f8ee89a-de28-4d4d-9a96-707b0393ee37/file",
            "schema": "/v2/schemas/image"
        }
    ]
}

Status codes

Success

Status Code	Description
200 - OK	Request was successful.

Error

Status Code	Description
400 - Bad Request	Some content in the request was invalid.
401 - Unauthorized	User must authenticate before making a request.
403 - Forbidden	Policy does not allow current user to do this operation.