List Snapshot


Lists all snapshots in a tenant Lists all snapshots of a volume


Snapshots are available only for Block Storage Volumes.


  • List

Synchronous / Asynchronous

  • Synchronous


HTTP Request Method

  • GET

HTTP Request Path


HTTP Request Header


X-Auth-Token: <token>

HTTP Request Body

  • none


HTTP Response Header

Response Code

Response Codes
Code Description Error? Note
200 OK No Returned in case of success
400 Bad Request Yes  
401 Unauthorized Yes  
500 Internal Server Error Yes  

HTTP Response Body

Response Parameter

Response Parameters
Parameter Type Description Note
api_error_message String Error message in API error case.  
id String Snapshot's ID (UUID)  
status String Snapshot status  
name String Name of snapshot Must be unique by tenant
description String Description of snapshot  
usage Integer The usage of snapshot in byte  
volume_id String volume ID (UUID)  
snapshot_type_id String ID (UUID) of snapshot_type  
created_at DateTime Creation timestamp for snapshot  
updated_at DateTime Update timestamp for snapshot  
deleted_at DateTime Delete timestamp for snapshot  
error_message String Error message for snapshot in case of error  
delete_reason String Delete reason why the snapshot automatically deleted  

Sample API Request and Response

Sample API Request

curl -s -i -X GET -H 'Content-type: application/json' -H 'Accept: application/json' -H 'X-Auth-Token: 9b2641e7460b4a5ebae3e9ce0ec472a7'

curl -s -i -X GET -H 'Content-type: application/json' -H 'Accept: application/json' -H 'X-Auth-Token: 9b2641e7460b4a5ebae3e9ce0ec472a7'

Sample API Response

HTTP/1.1 200 OK
Date: Wed, 25 Jan 2017 07:02:29 GMT
Server: Apache
Transfer-Encoding: chunked
Content-Type: application/json