v1

latestOpenAPI 3.0.12026-07-23429391.9 KB
Images

List images

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

get/images

Query parameters

limitinteger

Requests a page size of items

markerstring

The ID of the last-seen item

namestring

Filters the response by a name

ownerstring

Filters the response by a project ID

protectedboolean

Filters the response by the 'protected' image property

status'queued' | 'saving' | 'active' | 'killed' | 'deleted' | 'pending_delete' | 'deactivated' | 'uploading' | 'importing'

Filters the response by an image status

tagstring

Filters the response by the specified tag value

visibility'public' | 'private' | 'community' | 'shared'

Filters the response by an image visibility value

os_hiddenboolean

When true, filters the response to include only hidden images

member_status'pending' | 'accepted' | 'rejected'

Filters the response by a member status

size_maxstring

Filters the response by a maximum image size, in bytes

size_minstring

Filters the response by a minimum image size, in bytes

created_atstring

Specify a comparison filter based on the date and time when the resource was created

updated_atstring

Specify a comparison filter based on the date and time when the resource was most recently modified

sort_dir'asc' | 'desc'

Sorts the response by direction

sort_keystring

Sorts the response by an attribute

sortstring

Sorts the response by one or more attribute and sort direction combinations

Response

Images retrieved successfully

firststring uri

URI for the first page of response

nextstring uri

URI for the next page of response

schemastring uri

URL for the schema describing a list of images