Skip to content

List or read pool snapshots

List pool snapshots you can access or read one snapshot and its individual Computer snapshots. To copy a snapshot into a new pool, use pool create.

Parameters

#
poolstring
The pool whose snapshots to list, by name or ID.
snapshotstring
Pool snapshot name or ID. Includes its Computer snapshots.
sharedboolean
Snapshot access filter: true for snapshots shared with you, false for your account's snapshots. Omit for both.
organizationstring
Organization name or ID. A credential, named resource or sole membership can select the organization for you.

Returns

#
dataobjectAlways present
Accessible pool snapshots, or one snapshot with its per-Computer parts.
Show 2 attributesHide attributes
alternative-1object
Pool snapshots you can read, including snapshots shared with you.
Show 1 attributeHide attributes
pool_snapshotsobject[] | nullAlways present
Selected pool snapshots.
Show 1 attributeHide attributes
itemsobject
Disk snapshots captured from a pool. Sharing grants only disk-copy access.
Show 13 attributesHide attributes
computersintegerAlways present
Number of Computers represented by its parts.
created_atstring (date-time)Always present
When the grouped snapshot was created.
created_byobjectAlways present
Who requested the snapshot.
Show 2 attributesHide attributes
emailstring | nullAlways present
Their email address, or null when none is available.
user_idstringAlways present
Person's user ID.
expires_atstring (date-time) | nullAlways present
When it expires, or null if it has no expiry.
idstringAlways present
Pool snapshot's ID.
namestringAlways present
Its name within the pool.
notestringAlways present
Saved note about the snapshot.
partsobject[]
Individual saved disks, included when reading one snapshot. May be omitted.
Show 1 attributeHide attributes
itemsobject
A Computer's disk snapshot within a pool snapshot. Copying a part requires both Computer and snapshot identities.
Show 2 attributesHide attributes
computerobjectAlways present
Source Computer.
snapshotobjectAlways present
Its saved disk snapshot.
poolobjectAlways present
Source pool and its account.
Show 3 attributesHide attributes
idstringAlways present
Source pool's ID.
namestringAlways present
Source pool's name.
ownerobjectAlways present
Account that owns the source pool.
Show 4 attributesHide attributes
account_idstringAlways present
Account ID.
emailstring
Personal account owner's email. May be omitted.
kindstringAlways present
Whether the owner is an organization or a personal account.
namestring
Organization name. May be omitted.
regionstring
Region containing the source pool. May be omitted.
sharedbooleanAlways present
True when another account shared this snapshot with you.
shared_withobject[]
People this snapshot is shared with, visible to its account's members. May be omitted.
Show 1 attributeHide attributes
itemsobject
The person associated with a snapshot action or share.
Show 2 attributesHide attributes
emailstring | nullAlways present
Their email address, or null when none is available.
user_idstringAlways present
Person's user ID.
statestringAlways present
Grouped snapshot's recorded state.
alternative-2object
One pool snapshot and its per-Computer saved disks.
Show 1 attributeHide attributes
pool_snapshotobjectAlways present
Selected pool snapshot with its parts.
Show 13 attributesHide attributes
computersintegerAlways present
Number of Computers represented by its parts.
created_atstring (date-time)Always present
When the grouped snapshot was created.
created_byobjectAlways present
Who requested the snapshot.
Show 2 attributesHide attributes
emailstring | nullAlways present
Their email address, or null when none is available.
user_idstringAlways present
Person's user ID.
expires_atstring (date-time) | nullAlways present
When it expires, or null if it has no expiry.
idstringAlways present
Pool snapshot's ID.
namestringAlways present
Its name within the pool.
notestringAlways present
Saved note about the snapshot.
partsobject[]
Individual saved disks, included when reading one snapshot. May be omitted.
Show 1 attributeHide attributes
itemsobject
A Computer's disk snapshot within a pool snapshot. Copying a part requires both Computer and snapshot identities.
Show 2 attributesHide attributes
computerobjectAlways present
Source Computer.
Show 2 attributesHide attributes
idstringAlways present
Referenced object's stable ID.
namestringAlways present
Referenced object's name.
snapshotobjectAlways present
Its saved disk snapshot.
Show 9 attributesHide attributes
copiesinteger
Number of Computers copied from this part across accounts, visible only to source-account members. May be omitted.
disk_bytesstring | nullAlways present
Saved disk's logical size in bytes.
expires_atstring (date-time) | nullAlways present
When the saved snapshot expires, or null for no expiry.
idstringAlways present
Individual snapshot's ID.
namestringAlways present
Its name within the source Computer.
savedstring | nullAlways present
Disk capture method: stopped, flushed or unflushed. Null means capture is unreported.
size_bytesstring
Storage uniquely used by this snapshot, in bytes. May be omitted.
statestringAlways present
Snapshot's recorded state.
taken_atstring (date-time) | nullAlways present
When the disk was captured, or null before capture is reported.
poolobjectAlways present
Source pool and its account.
Show 3 attributesHide attributes
idstringAlways present
Source pool's ID.
namestringAlways present
Source pool's name.
ownerobjectAlways present
Account that owns the source pool.
Show 4 attributesHide attributes
account_idstringAlways present
Account ID.
emailstring
Personal account owner's email. May be omitted.
kindstringAlways present
Whether the owner is an organization or a personal account.
namestring
Organization name. May be omitted.
regionstring
Region containing the source pool. May be omitted.
sharedbooleanAlways present
True when another account shared this snapshot with you.
shared_withobject[]
People this snapshot is shared with, visible to its account's members. May be omitted.
Show 1 attributeHide attributes
itemsobject
The person associated with a snapshot action or share.
Show 2 attributesHide attributes
emailstring | nullAlways present
Their email address, or null when none is available.
user_idstringAlways present
Person's user ID.
statestringAlways present
Grouped snapshot's recorded state.

Errors

#
CodeStatusWhat happened
invalid400An input is missing or invalid.
unauthenticated401The credential is missing, invalid, expired or revoked.
denied403The caller lacks permission for this action.
not_found404The resource is absent or inaccessible to this caller.
conflict409The request conflicts with the current resource state or an earlier request.
over_capacity409The request exceeds a resource or credential allowance.
access_list_full409The change would exceed the access-list allowance.
rate_limited429The caller's request rate exceeds its limit.
busy429Too much work is in progress to accept this request.
unknown503The outcome is unconfirmed; a change may have happened.
unavailable503The service or requested feature is unavailable.

Notes

#
  • API key permission: pool snapshot view.