Apache CloudStack 4.23.0.0 Root Admin API Reference
listSnapshots
Lists all available snapshots for the account.
Request parameters
| Parameter Name | Description | Required |
| account | List resources by Account. Must be used with the domainId parameter. | false |
| domainid | List only resources belonging to the domain specified | false |
| id | Lists Snapshot by Snapshot ID | false |
| ids | The IDs of the Snapshots, mutually exclusive with id | false |
| imagestoreid | ID of the image or image cache store | false |
| intervaltype | Valid values are HOURLY, DAILY, WEEKLY, and MONTHLY. | false |
| isrecursive | Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. | false |
| keyword | List by keyword | false |
| listall | If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. | false |
| locationtype | list snapshots by location type. Used only when showunique=false. Valid location types: 'primary', 'secondary'. Default is empty | false |
| name | Lists Snapshot by Snapshot name | false |
| page | false | |
| pagesize | false | |
| projectid | List objects by project; if projectid=-1 lists All Instances | false |
| showunique | If set to false, list templates across zones and their storages | false |
| snapshottype | Valid values are MANUAL or RECURRING. | false |
| storageid | ID of the storage pool | false |
| tags | List resources by tags (key/value pairs) | false |
| volumeid | The ID of the disk volume | false |
| zoneid | List Snapshots by zone id | false |
Response Tags
| Response Name | Description |
| id | ID of the Snapshot |
| account | The Account associated with the Snapshot |
| chainsize | chain size of snapshot including all parent snapshots. Shown only for incremental snapshots if snapshot.show.chain.size setting is set to true |
| created | The date the Snapshot was created |
| datastoreid | ID of the datastore for the snapshot entry |
| datastorename | name of the datastore for the snapshot entry |
| datastorestate | state of the snapshot on the datastore |
| datastoretype | type of the datastore for the snapshot entry |
| domain | The domain name of the Snapshot's Account |
| domainid | The domain ID of the Snapshot's Account |
| domainpath | path of the Domain the snapshot's account belongs to |
| downloaddetails | download progress of a snapshot |
| intervaltype | Valid types are hourly, daily, weekly, monthy, Template, and none. |
| locationtype | Valid location types are primary and secondary. |
| name | Name of the Snapshot |
| osdisplayname | Display name of the os on volume |
| ostypeid | ID of the os on volume |
| parent | The parent ID of the Snapshot |
| parentname | The parent name of the Snapshot |
| physicalsize | Physical size of backed up Snapshot on image store |
| project | The project name of the Snapshot |
| projectid | The project id of the Snapshot |
| revertable | Indicates whether the underlying storage supports reverting the volume to this Snapshot |
| snapshottype | The type of the Snapshot |
| state | The state of the Snapshot. BackedUp means that Snapshot is ready to be used; Creating - the Snapshot is being allocated on the primary storage; BackingUp - the Snapshot is being backed up on secondary storage |
| status | the status of the template |
| virtualsize | Virtual size of backedup Snapshot on image store |
| volumeid | ID of the disk volume |
| volumename | Name of the disk volume |
| volumestate | state of the disk volume |
| volumetype | Type of the disk volume |
| zoneid | ID of the availability zone |
| zonename | name of the availability zone |
| jobid | the ID of the latest async job acting on this object |
| jobstatus | the current status of the latest async job acting on this object |