# openstack.image.v1.image

## The Image Class

The `Image` class inherits from `Resource`.

class openstack.image.v1.image.Image(_synchronized=False, connection=None, **attrs)

  The base resource

  Parameters:

    - _synchronized (bool) – This is not intended to be used directly. See `new()` and `existing()`.

    - connection (openstack.connection.Connection) – Reference to the Connection being used. Defaults to None to allow Resource objects to be used without an active Connection, such as in unit tests. Use of `self._connection` in Resource code should protect itself with a check for None.

  resource_key = 'image'

    Singular form of key for resource.

  resources_key = 'images'

    Plural form of key for resource.

  base_path = '/images'

    The base part of the URI for this resource.

  allow_create = True

    Allow create operation for this resource.

  allow_fetch = True

    Allow get operation for this resource.

  allow_commit = True

    Allow update operation for this resource.

  allow_delete = True

    Allow delete operation for this resource.

  allow_list = True

    Allow list operation for this resource.

  checksum

    Hash of the image data used. The Image service uses this value for verification.

  container_format

    The container format refers to whether the VM image is in a file format that also contains metadata about the actual VM. Container formats include OVF and Amazon AMI. In addition, a VM image might not have a container format - instead, the image is just a blob of unstructured data.

  copy_from

    A URL to copy an image from

  created_at

    The timestamp when this image was created.

  disk_format

    Valid values are: aki, ari, ami, raw, iso, vhd, vdi, qcow2, or vmdk. The disk format of a VM image is the format of the underlying disk image. Virtual appliance vendors have different formats for laying out the information contained in a VM disk image.

  is_protected

    Defines whether the image can be deleted. Type: bool

  is_public

    `True` if this is a public image. Type: bool

  location

    A location for the image identified by a URI

  min_disk

    The minimum disk size in GB that is required to boot the image.

  min_ram

    The minimum amount of RAM in MB that is required to boot the image.

  name

    Name for the image. Note that the name of an image is not unique to a Glance node. The API cannot expect users to know the names of images owned by others.

  owner

    The ID of the owner, or project, of the image.

  owner_id

    The ID of the owner, or project, of the image. (backwards compat)

  properties

    Properties, if any, that are associated with the image.

  size

    The size of the image data, in bytes.

  status

    The image status.

  updated_at

    The timestamp when this image was last updated.

  classmethod find(session, name_or_id, ignore_missing=True, list_base_path=None, *, microversion=None, all_projects=None, **params)

    Find a resource by its name or id.

    Parameters:

      - session (`Adapter`) – The session to use for making this request.

      - name_or_id – This resource’s identifier, if needed by the request. The default is `None`.

      - ignore_missing (bool) – When set to `False` `NotFoundException` will be raised when the resource does not exist. When set to `True`, None will be returned when attempting to find a nonexistent resource.

      - params (dict) – Any additional parameters to be passed into underlying methods, such as to `existing()` in order to pass on URI parameters.

    Returns:

      The `Resource` object matching the given name or id or None if nothing matches.

    Raises:

      `openstack.exceptions.DuplicateResource` if more than one resource is found for this request.

    Raises:

      `openstack.exceptions.NotFoundException` if nothing is found and ignore_missing is `False`.

this page last updated: 2026-01-16 23:06:19

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.