Images

Creates, lists, shows, updates, deletes, and performs other operations on images

List images

get

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

Authorizations
X-Auth-TokenstringRequired

OpenStack Keystone authentication token

Query parameters
limitintegerOptional

Requests a page size of items

markerstringOptional

The ID of the last-seen item

namestringOptional

Filters the response by a name

ownerstringOptional

Filters the response by a project ID

protectedbooleanOptional

Filters the response by the 'protected' image property

statusstring · enumOptional

Filters the response by an image status

Possible values:
tagstringOptional

Filters the response by the specified tag value

visibilitystring · enumOptional

Filters the response by an image visibility value

Possible values:
os_hiddenbooleanOptional

When true, filters the response to include only hidden images

member_statusstring · enumOptional

Filters the response by a member status

Possible values:
size_maxstringOptional

Filters the response by a maximum image size, in bytes

size_minstringOptional

Filters the response by a minimum image size, in bytes

created_atstringOptional

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

updated_atstringOptional

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

sort_dirstring · enumOptional

Sorts the response by direction

Possible values:
sort_keystringOptional

Sorts the response by an attribute

sortstringOptional

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

Responses
200

Images retrieved successfully

application/json
get
/images
GET /v2/images HTTP/1.1
Host: image.example.com
X-Auth-Token: YOUR_API_KEY
Accept: */*

{
  "images": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "status": "queued",
      "visibility": "public",
      "protected": true,
      "tags": [
        "text"
      ],
      "container_format": "ami",
      "disk_format": "ami",
      "min_disk": 1,
      "min_ram": 1,
      "size": 1,
      "virtual_size": 1,
      "checksum": "text",
      "os_hash_algo": "text",
      "os_hash_value": "text",
      "os_hidden": true,
      "owner": "text",
      "created_at": "2025-11-28T20:26:41.373Z",
      "updated_at": "2025-11-28T20:26:41.373Z",
      "self": "https://example.com",
      "file": "https://example.com",
      "schema": "https://example.com",
      "direct_url": "https://example.com",
      "locations": [
        {
          "url": "https://example.com",
          "metadata": {}
        }
      ],
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  ],
  "first": "https://example.com",
  "next": "https://example.com",
  "schema": "https://example.com"
}

Create image

post

Creates a catalog record for an operating system disk image

Authorizations
X-Auth-TokenstringRequired

OpenStack Keystone authentication token

Body
idstring · uuidOptional

A unique, user-defined image UUID

namestringOptional

The name of the image

container_formatstring · enumOptional

Format of the image container

Possible values:
disk_formatstring · enumOptional

The format of the disk

Possible values:
min_diskintegerOptional

Amount of disk space in GB that is required to boot the image

min_ramintegerOptional

Amount of RAM in MB that is required to boot the image

protectedbooleanOptional

Image protection for deletion

tagsstring[]Optional

List of tags for this image

visibilitystring · enumOptional

Visibility for this image

Possible values:
Other propertiesstringOptional

Additional custom properties

Responses
post
/images
POST /v2/images HTTP/1.1
Host: image.example.com
X-Auth-Token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 107

{
  "container_format": "bare",
  "disk_format": "raw",
  "name": "Ubuntu",
  "id": "b2173dd3-7ad6-4362-baa6-a68bce3565cb"
}
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "status": "queued",
  "visibility": "public",
  "protected": true,
  "tags": [
    "text"
  ],
  "container_format": "ami",
  "disk_format": "ami",
  "min_disk": 1,
  "min_ram": 1,
  "size": 1,
  "virtual_size": 1,
  "checksum": "text",
  "os_hash_algo": "text",
  "os_hash_value": "text",
  "os_hidden": true,
  "owner": "text",
  "created_at": "2025-11-28T20:26:41.373Z",
  "updated_at": "2025-11-28T20:26:41.373Z",
  "self": "https://example.com",
  "file": "https://example.com",
  "schema": "https://example.com",
  "direct_url": "https://example.com",
  "locations": [
    {
      "url": "https://example.com",
      "metadata": {}
    }
  ],
  "ANY_ADDITIONAL_PROPERTY": "text"
}

Show image details

get

Shows details for an image

Authorizations
X-Auth-TokenstringRequired

OpenStack Keystone authentication token

Path parameters
image_idstring · uuidRequired

The UUID of the image

Responses
200

Image details retrieved successfully

application/json
get
/images/{image_id}
GET /v2/images/{image_id} HTTP/1.1
Host: image.example.com
X-Auth-Token: YOUR_API_KEY
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "status": "queued",
  "visibility": "public",
  "protected": true,
  "tags": [
    "text"
  ],
  "container_format": "ami",
  "disk_format": "ami",
  "min_disk": 1,
  "min_ram": 1,
  "size": 1,
  "virtual_size": 1,
  "checksum": "text",
  "os_hash_algo": "text",
  "os_hash_value": "text",
  "os_hidden": true,
  "owner": "text",
  "created_at": "2025-11-28T20:26:41.373Z",
  "updated_at": "2025-11-28T20:26:41.373Z",
  "self": "https://example.com",
  "file": "https://example.com",
  "schema": "https://example.com",
  "direct_url": "https://example.com",
  "locations": [
    {
      "url": "https://example.com",
      "metadata": {}
    }
  ],
  "ANY_ADDITIONAL_PROPERTY": "text"
}

Delete image

delete

Deletes an image

Authorizations
X-Auth-TokenstringRequired

OpenStack Keystone authentication token

Path parameters
image_idstring · uuidRequired

The UUID of the image

Responses
delete
/images/{image_id}
DELETE /v2/images/{image_id} HTTP/1.1
Host: image.example.com
X-Auth-Token: YOUR_API_KEY
Accept: */*

No content

Update image

patch

Updates an image using JSON Patch operations

Authorizations
X-Auth-TokenstringRequired

OpenStack Keystone authentication token

Path parameters
image_idstring · uuidRequired

The UUID of the image

Bodyobject[]
opstring · enumRequired

The operation to perform

Possible values:
pathstringRequired

JSON pointer to the location in the target document

valueanyOptional

The value to use for the operation

Responses
200

Image updated successfully

application/json
patch
/images/{image_id}
PATCH /v2/images/{image_id} HTTP/1.1
Host: image.example.com
X-Auth-Token: YOUR_API_KEY
Content-Type: application/openstack-images-v2.1-json-patch
Accept: */*
Content-Length: 112

[
  {
    "op": "replace",
    "path": "/name",
    "value": "Fedora 17"
  },
  {
    "op": "replace",
    "path": "/tags",
    "value": [
      "fedora",
      "beefy"
    ]
  }
]
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "status": "queued",
  "visibility": "public",
  "protected": true,
  "tags": [
    "text"
  ],
  "container_format": "ami",
  "disk_format": "ami",
  "min_disk": 1,
  "min_ram": 1,
  "size": 1,
  "virtual_size": 1,
  "checksum": "text",
  "os_hash_algo": "text",
  "os_hash_value": "text",
  "os_hidden": true,
  "owner": "text",
  "created_at": "2025-11-28T20:26:41.373Z",
  "updated_at": "2025-11-28T20:26:41.373Z",
  "self": "https://example.com",
  "file": "https://example.com",
  "schema": "https://example.com",
  "direct_url": "https://example.com",
  "locations": [
    {
      "url": "https://example.com",
      "metadata": {}
    }
  ],
  "ANY_ADDITIONAL_PROPERTY": "text"
}

Deactivate image

post

Deactivates an image (admin only)

Authorizations
X-Auth-TokenstringRequired

OpenStack Keystone authentication token

Path parameters
image_idstring · uuidRequired

The UUID of the image

Responses
post
/images/{image_id}/actions/deactivate
POST /v2/images/{image_id}/actions/deactivate HTTP/1.1
Host: image.example.com
X-Auth-Token: YOUR_API_KEY
Accept: */*

No content

Reactivate image

post

Reactivates an image (admin only)

Authorizations
X-Auth-TokenstringRequired

OpenStack Keystone authentication token

Path parameters
image_idstring · uuidRequired

The UUID of the image

Responses
post
/images/{image_id}/actions/reactivate
POST /v2/images/{image_id}/actions/reactivate HTTP/1.1
Host: image.example.com
X-Auth-Token: YOUR_API_KEY
Accept: */*

No content
PreviousModelsNextImage Tags

Last updated

Was this helpful?