---
title: "List images"
method: GET
path: "/images"
tags: ["Images"]
---

# List images

`GET /images`

Lists public virtual machine (VM) images with pagination and filtering support

## Query parameters

- `limit` integer
- `marker` string
- `name` string
- `owner` string
- `protected` boolean
- `status` 'queued' | 'saving' | 'active' | 'killed' | 'deleted' | 'pending_delete' | 'deactivated' | 'uploading' | 'importing'
- `tag` string
- `visibility` 'public' | 'private' | 'community' | 'shared'
- `os_hidden` boolean
- `member_status` 'pending' | 'accepted' | 'rejected'
- `size_max` string
- `size_min` string
- `created_at` string
- `updated_at` string
- `sort_dir` 'asc' | 'desc'
- `sort_key` string
- `sort` string

## Response `200`

Images retrieved successfully

- ImageList
  - `images` Image[]
    - `id` string, uuid, required — A unique identifier for the image
    - `name` string, nullable — The name of the image
    - `status` 'queued' | 'saving' | 'active' | 'killed' | 'deleted' | 'pending_delete' | 'deactivated' | 'uploading' | 'importing', required — The image status
    - `visibility` 'public' | 'private' | 'community' | 'shared', required — Image visibility
    - `protected` boolean, required — Image protection for deletion
    - `tags` string[], required — List of tags for this image
    - `container_format` 'ami' | 'ari' | 'aki' | 'bare' | 'ovf' | 'ova' | 'docker' | 'compressed', nullable — Format of the image container
    - `disk_format` 'ami' | 'ari' | 'aki' | 'vhd' | 'vhdx' | 'vmdk' | 'raw' | 'qcow2' | 'vdi' | 'iso' | 'ploop', nullable — The format of the disk
    - `min_disk` integer — Amount of disk space in GB required to boot the image
    - `min_ram` integer — Amount of RAM in MB required to boot the image
    - `size` integer, nullable — The size of the image data, in bytes
    - `virtual_size` integer, nullable — The virtual size of the image
    - `checksum` string, nullable — MD5 hash of image contents
    - `os_hash_algo` string, nullable — Algorithm used to compute secure hash
    - `os_hash_value` string, nullable — Hexdigest of the secure hash
    - `os_hidden` boolean — Controls whether image is displayed in default image list
    - `owner` string, nullable — An identifier for the owner of the image
    - `created_at` string, date-time, required — Date and time when the image was created
    - `updated_at` string, date-time, required — Date and time when the image was last updated
    - `self` string, uri, required — URL for the image
    - `file` string, uri — URL for the image file
    - `schema` string, uri, required — URL for the schema describing the image
    - `direct_url` string, uri — URL to access the image file kept in external store
    - `locations` object[] — List of image locations
      - `url` string, uri
      - `metadata` object
  - `first` string, uri — URI for the first page of response
  - `next` string, uri — URI for the next page of response
  - `schema` string, uri — URL for the schema describing a list of images

## Other responses

- `400` — Bad Request
- `401` — Missing or invalid JWT token.
- `403` — Token does not have permission for this operation.

---

[API](https://skmtc.net/platform9/apis/cluster-blueprint-api.md) · [All operations](https://skmtc.net/platform9/apis/cluster-blueprint-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/platform9/cluster-blueprint-api/revisions/708ad90fe444/schema)