Get Collection of Disk Snapshots

You can get information on all snapshot of virtual disks created by Veeam Backup for Microsoft Azure.

Request

To retrieve information on snapshots, send the HTTP GET request to the /diskSnapshots endpoint.

HTTP Request

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

Query Parameters

To control the amount and order of data in the response, you can use Offset, Limit and the following query parameters:

Query Parameter

Value

Description

RestorePointId

string

Returns only data stored at the specified point in time.

VirtualMachineId

string

Returns only snapshots of virtual disks that are attached to a specified Azure VM.

Request Headers

The request contains the following headers.

Header

Required

Value

Description

Authorization

Required

Bearer <Access-Token>

Authenticates a client who sends the request to the server. Must contain the access token for the current logon session in the Bearer <Access-Token> format.

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 HTTP headers.

Header

Value

Description

Content-length

integer

Identifies the length of the response body message, in bytes.

Content-type

  • application/json
  • application/problem+json

Identifies the media type of the response body message.

Response Body

In the response body, Veeam Backup for Microsoft Azure returns information on snapshots of virtual disks. The DiskSnapshotV2 schema is used for the collection representation.

Get Collection of Disk SnapshotsExample

The following request returns information on the virtual disk snapshot.

Request:

GET https://51.11.247.127/api/v2/diskSnapshots

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200

 

Response Body:

{

 "offset": 0,

 "limit": 200,

 "results": [

   {

     "name": "Veeam.Snapshot.d8ffdb87-1663-47f0-a913-1e4a8e2fe902",

     "diskType": "Managed",

     "sku": "StandardHdd",

     "sizeInGB": 30,

     "osType": "Linux",

     "diskId": "uihqmw81pjpu8n4nfe6f1qceb489xazb931pwhdpt3c5hw7rx4sy",

     "subscription": {

       "id": "3a9a4930-7bbc-4b83-9c68-15d674fbc803",

       "environment": "Global",

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

       "name": "Visual Studio Premium MSDN",

       "status": "Active"

     },

     "region": {

       "id": "canadacentral",

       "name": "Canada Central"

     },

     "resourceGroup": {

       "id": "s8jykxn3c6tfhjdqr431ihydpz4buwusdnu4okz619gfxwcwxcdo",

       "resourceId": "/subscriptions/3a9a4930-7bbc-4b83-9c68-15d674fbc803/resourcegroups/victor-rg_canada",

       "name": "Victor-RG_Canada",

       "azureEnvironment": "Global",

       "subscriptionId": "3a9a4930-7bbc-4b83-9c68-15d674fbc803",

       "regionId": "canadacentral"

     },

     "_links": {

       "restorepoint": {

         "href": "https://13.77.147.210/api/v2/restorePoints/b518a5c6-c4d3-4b54-bb7e-354a5a2d6848"

       },

       "virtualmachine": {

         "href": "https://13.77.147.210/api/v2/virtualMachineSnapshots?restorePointId=b518a5c6-c4d3-4b54-bb7e-354a5a2d6848"

       }

     },

     "diskName": "test-proxy-can_OsDisk_1_11ce28e35a0f4228b369dbb0bcac3498"

   },

   {

     "name": "Veeam.Snapshot.7235b35a-d5dc-4705-bcc8-5ab75e68483f",

     "diskType": "Managed",

     "sku": "StandardSsd",

     "sizeInGB": 30,

     "osType": "Linux",

     "diskId": "x4bw55keuoj8sw45kp3qfpu6ooj5isr3ornfxredcn7ym9dq777o",

     "subscription": {

       "id": "3a9a4930-7bbc-4b83-9c68-15d674fbc803",

       "environment": "Global",

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

       "name": "Visual Studio Premium MSDN",

       "status": "Active"

     },

     "region": {

       "id": "eastus",

       "name": "East US"

     },

     "resourceGroup": {

       "id": "qynupco574sfhy1io48okzz83cxjxqan1rhpaztznjt5o61w4wqo",

       "resourceId": "/subscriptions/3a9a4930-7bbc-4b83-9c68-15d674fbc803/resourcegroups/honzatests",

       "name": "HonzaTests",

       "azureEnvironment": "Global",

       "subscriptionId": "3a9a4930-7bbc-4b83-9c68-15d674fbc803",

       "regionId": "westeurope"

     },

     "_links": {

       "restorepoint": {

         "href": "https://13.77.147.210/api/v2/restorePoints/1f4d5acd-fdb1-4a2d-afdd-aab94d5c3d40"

       },

       "virtualmachine": {

         "href": "https://13.77.147.210/api/v2/virtualMachineSnapshots?restorePointId=1f4d5acd-fdb1-4a2d-afdd-aab94d5c3d40"

       }

     },

     "diskName": "HonzaVm-Managed-US_disk1_c597098ba4ca491d9f02aac6a72ea77d"

   },

   {

     "name": "Veeam.Snapshot.b436df2c-d780-4bf3-9189-689643c2bd07",

     "diskType": "Managed",

     "sku": "StandardHdd",

     "sizeInGB": 30,

     "osType": "Linux",

     "diskId": "74dirwegi3mkrc5ihd1zbyy8r4myqaqa191egik13ttwmjkmh37o",

     "subscription": {

       "id": "3a9a4930-7bbc-4b83-9c68-15d674fbc803",

       "environment": "Global",

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

       "name": "Visual Studio Premium MSDN",

       "status": "Active"

     },

     "region": {

       "id": "canadaeast",

       "name": "Canada East"

     },

     "resourceGroup": {

       "id": "ruo53jh6kuo719bofhmj7oup5jmjxzhzqkdj7uqhj11h5cggn5ay",

       "resourceId": "/subscriptions/3a9a4930-7bbc-4b83-9c68-15d674fbc803/resourcegroups/jakubeiselt",

       "name": "JakubEiselt",

       "azureEnvironment": "Global",

       "subscriptionId": "3a9a4930-7bbc-4b83-9c68-15d674fbc803",

       "regionId": "francecentral"

     },

     "_links": {

       "restorepoint": {

         "href": "https://13.77.147.210/api/v2/restorePoints/08f9aa7f-4f62-40a0-9003-187ef0a94450"

       },

       "virtualmachine": {

         "href": "https://13.77.147.210/api/v2/virtualMachineSnapshots?restorePointId=08f9aa7f-4f62-40a0-9003-187ef0a94450"

       }

     },

     "diskName": "HonzaVm-UnManaged-US20201214164837"

   },

 ],

 "_links": {

   "self": {

     "href": "https://13.77.147.210:443/api/v2/diskSnapshots?offset=0&limit=200"

   }

 }

}

I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.