This is an archive version of the document. To get the most up-to-date information, see the current version.

Getting Disk Snapshots

This section explains how to get a list with Azure snapshots.

Request

GET https://<hostname>/api/v1/diskSnapshots

Request Headers

The request header must contain an authorization token of the current session.

Request Parameters

None.

Request Body

None.

Response

The server returns the following response to the client.

Response Codes

A successfully completed operation returns a response code 200 (OK).

Response Headers

The response to this request contains the following headers. The response may also include additional standard HTTPS headers.

Header	Description
Content-length	The length of the response body.
Content-type	The media type and syntax of the response body message: application/json; charset=utf-8

Response Body

Property	Type	Description
offset	integer	Shows the offset value.
limit	integer	Shows the offset limit.
_links	Dictionary of string [key] and Object [value]	Links to related resources (navigation property).

Results Object

Property	Type	Description
name	string	Shows the name if the snapshot.
diskType	string	Shows the disk type. Can be Managed and Unmanaged.
sku	string	Shows Azure SKU.
sizeInGB	string	Shows the size of the snapshot.
osType	string	Shows the operation system type.
diskId	string	Shows the identification number of the disk.
subscription	AzureSubscription Object	Contains the subscription object.
region	Region Object	Contains the region object.
resourceGroup	ResourceGroup Object	Contains the resource object.
storageAccount	StorageAccount Object	Contains the storage account object.

AzureSubscription Object

Property	Type	Description
id	string	Shows the identification number of the Azure subscription.
environment	string	Shows the Azure environment.
tenantId	string	Shows the identification number of the tenant.
name	string	Shows the name of the Azure subscription.
status	string	Shows the status of the Azure subscription.

Region Object

Property	Type	Description
id	string	Shows the identification number of the region.
name	string	Shows the name of the region.

ResourceGroup Object

Property	Type	Description
id	string	Shows the identification number of the Azure resource group.
resourceId	string	Shows the identification number of the resource.
name	string	Shows the name if the resource group.
azureEnvironment	string	Shows the Azure environment.
subscriptionId	string	Shows the identification number of the subscription.
regionId	string	Shows the identification number of the region.

StorageAccount Object

Property	Type	Description
id	string	Shows the identification number of the Azure storage account.
resourceId	string	Shows the identification number of the resource.
name	string	Shows the identification number of the storage account.
skuName	string	Shows Azure SKU.
performance	string	Shows the snapshot performance. For more information, see this Microsoft article.
redundancy	string	Shows the snapshot redundancy. For more information, see this Microsoft article.
accessTier	string	Shows the access tier type.
regionId	string	Shows the identification number of the Azure region to which the snapshot belongs.
regionName	string	Shows the identification number of the region.
removedFromAzure	boolean	Shows if the snapshot was removed from Azure.

Example

Request:

GET https://abc.ukwest.cloudapp.azure.com/api/v1/diskSnapshots

Request Header:

Authorization: Bearer <Access-Token>

Response:

200 OK

Response Body:

{

"offset": 0,

"limit": 30,

"results": [ {

"name": "TW-VM220191121172724",

"diskType": "Unmanaged",

"sku": "StandardHdd",

"sizeInGB": 127,

"osType": "Windows",

"diskId": "dipiyzokgsb9smukrd38mqqp6rpmdmegxuny98n5wg9uou8rjm4y",

"subscription": {

"id": "3a9a8330-7bbc-4b03-9c68-15d674fbc809",

"environment": "Global",

"tenantId": "3e924ba9-93bc-40d5-8a47-33f07b239a52",

"name": "Visual Studio Premium MSDN",

"status": "Active"

"region": {

"id": "northeurope",

"name": "North Europe"

"resourceGroup": {

"id": "9rfsjj51bq9peuun3hcqfo96pthfsjkj4tiibw4awpnabwgywxty",

"resourceId": "/subscriptions/3a9a8330-7bbc-4b03-9c68-15d674fbc809/resourcegroups/twresourcegroup",

"name": "twresourcegroup",

"azureEnvironment": "Global",

"subscriptionId": "3a9a8330-7bbc-4b03-9c68-15d674fbc809",

"regionId": "ukwest"

"storageAccount": {

"id": "6izdxgzy6shhe1oi3gu6ofqkium7ei4ibugy5jpf7p13an7ie7gy",

"resourceId": "/subscriptions/3a9a8330-7bbc-4b03-9c68-15d674fbc809/resourcegroups/twresourcegroup/providers/microsoft.storage/storageaccounts/twresourcegroupdisks",

"name": "twresourcegroupdisks",

"skuName": "Standard_LRS",

"performance": "Standard",

"redundancy": "Uknown",

"accessTier": "Hot",

"regionId": "northeurope",

"regionName": "North Europe",

"removedFromAzure": false,

"_links": {}

"_links": {

"restorepoint": {"href": "https://abc.ukwest.cloudapp.azure.com/api/v1/restorePoints/f8ba6fe1-0f47-43d4-8dce-24149522722f"},

"virtualmachine": {"href": "https://abc.ukwest.cloudapp.azure.com/api/v1/virtualMachineSnapshots?restorePointId=f8ba6fe1-0f47-43d4-8dce-24149522722f"}

}

}],

"_links": {"self": {"href": "https://abc.ukwest.cloudapp.azure.com:443/api/v1/diskSnapshots?offset=0&limit=30"}}

}