# openstack.block_storage.v3.snapshot

## The Snapshot Class

The `Snapshot` class inherits from `Resource`.

class openstack.block_storage.v3.snapshot.Snapshot(_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 = 'snapshot'

    Singular form of key for resource.

  resources_key = 'snapshots'

    Plural form of key for resource.

  base_path = '/snapshots'

    The base part of the URI for this resource.

  allow_fetch = True

    Allow get operation for this resource.

  allow_create = True

    Allow create operation for this resource.

  allow_delete = True

    Allow delete operation for this resource.

  allow_commit = True

    Allow update operation for this resource.

  allow_list = True

    Allow list operation for this resource.

  consumes_quota

    Whether this resource consumes quota or not. Resources that not counted for quota usage are usually temporary internal resources created to perform an operation. This is included from microversion 3.65

  created_at

    The timestamp of this snapshot creation.

  description

    Description of snapshot. Default is None.

  group_snapshot_id

    The ID of the group snapshot. This is included from microversion 3.14

  is_forced

    Indicate whether to create snapshot, even if the volume is attached. Default is `False`. Type: bool

  progress

    The percentage of completeness the snapshot is currently at.

  project_id

    The project ID this snapshot is associated with.

  size

    The size of the volume, in gibibytes (GiB).

  status

    The current status of this snapshot. Potential values are creating, available, deleting, error, and error_deleting.

  updated_at

    The date and time when the resource was updated.

  user_id

    The UUID of the user. This is included from microversion 3.41

  volume_id

    The ID of the volume this snapshot was taken of.

  force_delete(session)

    Force snapshot deletion.

  reset_status(session, status)

    Reset the status of the snapshot.

  set_status(session, status, progress=None)

    Update fields related to the status of a snapshot.

  classmethod manage(session, volume_id, ref, name=None, description=None, metadata=None)

    Manage a snapshot under block storage provisioning.

  unmanage(session)

    Unmanage a snapshot from block storage provisioning.

## The SnapshotDetail Class

The `SnapshotDetail` class inherits from `Snapshot`.

openstack.block_storage.v3.snapshot.SnapshotDetail

  alias of `Snapshot`

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.