Veeam Backup for Microsoft Azure 8
REST API Reference
Related documents

Azure VM Restore Points

The /restorePoints/virtualMachines resource collection represents restore points of Azure VMs available for Veeam Backup for Microsoft Azure.

Get Azure VM Restore Points

The HTTP GET request to the /restorePoints/virtualMachines endpoint retrieves a list of restore points created for Azure VMs by Veeam Backup for Microsoft Azure.

SecurityBearer
Request
query Parameters
VirtualMachineId
string or null

Returns only restore points of an Azure VM with the specified ID.

x-veeam-parameter-group: VirtualMachineRestorePointSearchOptions
DiskId
string or null

Returns only restore points of a virtual disk with the specified ID.

x-veeam-parameter-group: VirtualMachineRestorePointSearchOptions
OnlyLatest
boolean

Defines whether to return only recently created restore points.

x-veeam-parameter-group: VirtualMachineRestorePointSearchOptions
DataRetrievalStatuses
Array of strings or null (DataRetrievalStatus)

Returns only restore points with the specified data retrieval status.

Enum: "None" "Retrieving" "Retrieved" "Unknown"
x-veeam-parameter-group: VirtualMachineRestorePointSearchOptions
PointInTime
string or null <date-time>

Returns only restore points created on the specified date and time.

x-veeam-parameter-group: VirtualMachineRestorePointSearchOptions
Offset
integer <int32> >= 0

Specifies the first N items of a resource collection that will be excluded from the response.

x-veeam-parameter-group: Veeam.Azure.REST.RequestQuery.V2.PageProperties
Limit
integer <int32> >= -1

Specifies the maximum number of items of a resource collection that will be returned in the response.

x-veeam-parameter-group: Veeam.Azure.REST.RequestQuery.V2.PageProperties
StorageAccessTier
Array of strings or null or null (StorageAccessTier)

Returns only restore points stored in repositories of the specified access tier.

Enum: "Hot" "Cool" "Archive" "Inferred" "Cold"
x-veeam-parameter-group: VirtualMachineRestorePointSearchOptions
ImmutabilityEnabled
boolean

Returns only restore points with the specified immutability.

x-veeam-parameter-group: VirtualMachineRestorePointSearchOptions
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

get/api/v8/restorePoints/virtualMachines
Request samples 
curl -i -X GET \
  'https://123.123.123.123/api/v8/restorePoints/virtualMachines?VirtualMachineId=string&DiskId=string&OnlyLatest=true&DataRetrievalStatuses=None&PointInTime=2019-08-24T14%3A15%3A22Z&Offset=0&Limit=-1&StorageAccessTier=Hot&ImmutabilityEnabled=true' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "totalCount": 0,
  • "_links": {},
  • "results": [
    ]
}

Get Azure VM Restore Point Data

The HTTP GET request to the /restorePoints/virtualMachines/{restorePointId} endpoint retrieves information on a specific restore point of an Azure VM.

SecurityBearer
Request
path Parameters
restorePointId
required
string <uuid>

Specifies the system ID assigned to a restore point in the Veeam Backup for Microsoft Azure REST API.

Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

get/api/v8/restorePoints/virtualMachines/{restorePointId}
Request samples 
curl -i -X GET \
  'https://123.123.123.123/api/v8/restorePoints/virtualMachines/{restorePointId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "Full",
  • "vbrId": "string",
  • "pointInTime": "2019-08-24T14:15:22Z",
  • "pointInTimeLocalTime": "2019-08-24T14:15:22Z",
  • "backupSizeBytes": 0,
  • "isCorrupted": true,
  • "vmName": "string",
  • "resourceHashId": "string",
  • "regionId": "string",
  • "regionName": "string",
  • "backupDestination": "Snapshot",
  • "gfsFlags": "string",
  • "jobSessionId": "string",
  • "_links": {},
  • "dataRetrievalStatus": "None",
  • "retrievedDataExpirationDate": "2019-08-24T14:15:22Z",
  • "notifyBeforeRetrievedDataExpirationHours": 0,
  • "immutableTill": "2019-08-24T14:15:22Z",
  • "accessTier": "Hot",
  • "latestChainSizeBytes": 0
}

Remove Azure VM Restore Point

The HTTP DELETE request to the /restorePoints/virtualMachines/{restorePointId} endpoint removes a specific restore point of an Azure VM from the Veeam Backup for Microsoft Azure configuration database.

SecurityBearer
Request
path Parameters
restorePointId
required
string <uuid>

Specifies the system ID assigned to a restore point in the Veeam Backup for Microsoft Azure REST API.

Responses
202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

423

Locked

delete/api/v8/restorePoints/virtualMachines/{restorePointId}
Request samples 
curl -i -X DELETE \
  'https://123.123.123.123/api/v8/restorePoints/virtualMachines/{restorePointId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "string",
  • "type": "BackupRetention",
  • "localizedType": "string",
  • "executionStartTime": "2019-08-24T14:15:22Z",
  • "executionStopTime": "2019-08-24T14:15:22Z",
  • "executionDuration": "string",
  • "status": "Canceled",
  • "backupJobInfo": {
    },
  • "healthCheckJobInfo": {
    },
  • "restoreJobInfo": {
    },
  • "fileLevelRestoreJobInfo": {
    },
  • "fileShareFileLevelRestoreJobInfo": {
    },
  • "repositoryJobInfo": {
    },
  • "restorePointDataRetrievalJobInfo": {
    },
  • "retentionJobInfo": {
    },
  • "_links": {}
}

Perform Virtual Disk Restore

The HTTP POST request to the /restorePoints/virtualMachines/{restorePointId}/restoreDisk endpoint launches a disk restore operation using a specific restore point of an Azure VM.

SecurityBearer
Request
path Parameters
restorePointId
required
string <uuid>

Specifies the system ID assigned to a restore point in the Veeam Backup for Microsoft Azure REST API.

Request Body schema: application/json
required
reason
required
string

Specifies a reason for performing the restore operation.

serviceAccountId
string

Specifies the system ID assigned in the Veeam Backup for Microsoft Azure REST API to a service account whose permissions will be used to perform the restore operation.
Note: This parameter is required.

sourceServiceAccountId
string or null

Specifies the system ID assigned in the Veeam Backup for Microsoft Azure REST API to a service account whose permissions were used to perform the backup operation.

object or null (DiskBulkRestoreToOriginalOptions)

/[Applies only if restore to the original location is performed/] Specifies disk restore settings.

Array of objects or null (DiskRestoreOptions)

[Applies if restore is performed to a new location or with different settings] Specifies disk restore settings.

Responses
202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

415

Client Error

post/api/v8/restorePoints/virtualMachines/{restorePointId}/restoreDisk
Request samples
application/json
{
  • "reason": "string",
  • "serviceAccountId": "string",
  • "sourceServiceAccountId": "string",
  • "toOriginal": {
    },
  • "toAlternative": [
    ]
}
Response samples
application/json
{
  • "id": "string",
  • "type": "BackupRetention",
  • "localizedType": "string",
  • "executionStartTime": "2019-08-24T14:15:22Z",
  • "executionStopTime": "2019-08-24T14:15:22Z",
  • "executionDuration": "string",
  • "status": "Canceled",
  • "backupJobInfo": {
    },
  • "healthCheckJobInfo": {
    },
  • "restoreJobInfo": {
    },
  • "fileLevelRestoreJobInfo": {
    },
  • "fileShareFileLevelRestoreJobInfo": {
    },
  • "repositoryJobInfo": {
    },
  • "restorePointDataRetrievalJobInfo": {
    },
  • "retentionJobInfo": {
    },
  • "_links": {}
}

Perform Azure VM Restore

The HTTP POST request to the /restorePoints/virtualMachines/{restorePointId}/restoreVirtualMachine endpoint launches an Azure VM restore operation using a specific restore point.

SecurityBearer
Request
path Parameters
restorePointId
required
string <uuid>

Specifies the system ID assigned to a restore point in the Veeam Backup for Microsoft Azure REST API.

Request Body schema: application/json
required
reason
required
string

Specifies a reason for performing the restore operation.

serviceAccountId
string or null

Specifies the system ID assigned in the Veeam Backup for Microsoft Azure REST API to a service account whose permissions will be used to perform the operation.
Note: This parameter is required.

sourceServiceAccountId
string or null

Specifies the system ID assigned in the Veeam Backup for Microsoft Azure REST API to a service account whose permissions were used to perform the backup operation.

object or null (VirtualMachineToAlternativeRestoreOptions)

/[Applies if restore is performed to a new location or with different settings/] Specifies Azure VM restore settings.

x-veeam-namespace: Veeam.Azure.REST.Representation.V2.Actions
startVmAfterRestore
boolean

Defines whether to start the restored Azure VM after the restore operation completes.

Responses
202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

415

Client Error

post/api/v8/restorePoints/virtualMachines/{restorePointId}/restoreVirtualMachine
Request samples
application/json
{
  • "reason": "string",
  • "serviceAccountId": "string",
  • "sourceServiceAccountId": "string",
  • "toAlternative": {
    },
  • "startVmAfterRestore": true
}
Response samples
application/json
{
  • "id": "string",
  • "type": "BackupRetention",
  • "localizedType": "string",
  • "executionStartTime": "2019-08-24T14:15:22Z",
  • "executionStopTime": "2019-08-24T14:15:22Z",
  • "executionDuration": "string",
  • "status": "Canceled",
  • "backupJobInfo": {
    },
  • "healthCheckJobInfo": {
    },
  • "restoreJobInfo": {
    },
  • "fileLevelRestoreJobInfo": {
    },
  • "fileShareFileLevelRestoreJobInfo": {
    },
  • "repositoryJobInfo": {
    },
  • "restorePointDataRetrievalJobInfo": {
    },
  • "retentionJobInfo": {
    },
  • "_links": {}
}

Perform Azure VM File-Level Restore

The HTTP POST request to the /restorePoints/virtualMachines/{restorePointId}/restoreFile endpoint launches a file-level restore operation using a specific restore point of an Azure VM.

SecurityBearer
Request
path Parameters
restorePointId
required
string <uuid>

Specifies the system ID assigned to a restore point in the Veeam Backup for Microsoft Azure REST API.

Request Body schema: application/json
required
reason
string or null

Specifies a reason for performing the restore operation.

serviceAccountId
string or null

Specifies the system ID assigned in the Veeam Backup for Microsoft Azure to a service account whose permissions will be used to restore data to the original location. If not provided, only download option will be available for the user.

flrRto
boolean

Defines whether to restore data to the original location.

Responses
202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

415

Client Error

post/api/v8/restorePoints/virtualMachines/{restorePointId}/restoreFile
Request samples
application/json
{
  • "reason": "string",
  • "serviceAccountId": "string",
  • "flrRto": true
}
Response samples
application/json
{
  • "id": "string",
  • "type": "BackupRetention",
  • "localizedType": "string",
  • "executionStartTime": "2019-08-24T14:15:22Z",
  • "executionStopTime": "2019-08-24T14:15:22Z",
  • "executionDuration": "string",
  • "status": "Canceled",
  • "backupJobInfo": {
    },
  • "healthCheckJobInfo": {
    },
  • "restoreJobInfo": {
    },
  • "fileLevelRestoreJobInfo": {
    },
  • "fileShareFileLevelRestoreJobInfo": {
    },
  • "repositoryJobInfo": {
    },
  • "restorePointDataRetrievalJobInfo": {
    },
  • "retentionJobInfo": {
    },
  • "_links": {}
}

Retrieve Data from Archive

The HTTP POST request to the /restorePoints/virtualMachines/{restorePointId}/retrieveData endpoint retrieves data of an archived restore point with the specified ID.

SecurityBearer
Request
path Parameters
restorePointId
required
string <uuid>

Specifies the system ID assigned to a restore point in the Veeam Backup for Microsoft Azure REST API.

Request Body schema: application/json
required
dataRetrievalPriority
required
string (DataRetrievalPriority)

Specifies the priority type for the data retrieval operation.

Enum: "Normal" "High" "Unknown"
daysToKeep
integer <int32> [ 1 .. 30 ]

Specifies the number of days for which the retrieved data will be kept.

notifyBeforeExpirationHours
integer or null <int32>

Specifies the time when a notification will be sent (in hours remaining until the expiration).

notifyAfterComplete
boolean or null

Defines whether a notification must be sent after the operation is complete.

Responses
202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

409

Conflict

415

Client Error

post/api/v8/restorePoints/virtualMachines/{restorePointId}/retrieveData
Request samples
application/json
{
  • "dataRetrievalPriority": "Normal",
  • "daysToKeep": 1,
  • "notifyBeforeExpirationHours": 0,
  • "notifyAfterComplete": true
}
Response samples
application/json
{
  • "id": "string",
  • "type": "BackupRetention",
  • "localizedType": "string",
  • "executionStartTime": "2019-08-24T14:15:22Z",
  • "executionStopTime": "2019-08-24T14:15:22Z",
  • "executionDuration": "string",
  • "status": "Canceled",
  • "backupJobInfo": {
    },
  • "healthCheckJobInfo": {
    },
  • "restoreJobInfo": {
    },
  • "fileLevelRestoreJobInfo": {
    },
  • "fileShareFileLevelRestoreJobInfo": {
    },
  • "repositoryJobInfo": {
    },
  • "restorePointDataRetrievalJobInfo": {
    },
  • "retentionJobInfo": {
    },
  • "_links": {}
}

Extend Data Availability Period

The HTTP POST request to the /restorePoints/virtualMachines/{restorePointId}/extendRetrievedDataAvailability endpoint extends the data availability period of a retrieved restore point with the specified ID.

SecurityBearer
Request
path Parameters
restorePointId
required
string <uuid>

Specifies the system ID assigned to a restore point in the Veeam Backup for Microsoft Azure REST API.

Request Body schema: application/json
required
numberOfDays
integer <int32> [ 1 .. 30 ]

Specifies the number of days for which the data availability period will be extended.

Responses
204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

415

Client Error

post/api/v8/restorePoints/virtualMachines/{restorePointId}/extendRetrievedDataAvailability
Request samples
application/json
{
  • "numberOfDays": 1
}
Response samples
application/problem+json
{
  • "extensions": { },
  • "status": 0,
  • "title": "string",
  • "detail": "string",
  • "type": "string"
}

Get Collection of Virtual Disk Snapshots

The HTTP GET request to the /restorePoints/virtualMachines/diskSnapshots endpoint retrieves a list of virtual disk snapshots of Azure VMs.

SecurityBearer
Request
query Parameters
RestorePointId
string or null <uuid>

Returns only snapshots associated with a restore point with the specified ID.

x-veeam-parameter-group: VirtualMachineSnapshotFilter
VirtualMachineId
string or null

Returns only snapshots of virtual disks attached to an Azure VM with the specified ID.

x-veeam-parameter-group: VirtualMachineSnapshotFilter
Offset
integer <int32> >= 0

Specifies the first N items of a resource collection that will be excluded from the response.

x-veeam-parameter-group: Veeam.Azure.REST.RequestQuery.V2.PageProperties
Limit
integer <int32> >= -1

Specifies the maximum number of items of a resource collection that will be returned in the response.

x-veeam-parameter-group: Veeam.Azure.REST.RequestQuery.V2.PageProperties
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

get/api/v8/restorePoints/virtualMachines/diskSnapshots
Request samples 
curl -i -X GET \
  'https://123.123.123.123/api/v8/restorePoints/virtualMachines/diskSnapshots?RestorePointId=497f6eca-6276-4993-bfeb-53cbbbba6f08&VirtualMachineId=string&Offset=0&Limit=-1' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "totalCount": 0,
  • "_links": {},
  • "results": [
    ]
}

Virtual Disk Snapshots Rescan

The HTTP POST request to the /restorePoints/virtualMachines/diskSnapshots/rescan endpoint launches a snapshot rescan operation in the Microsoft Azure environment.

SecurityBearer
Responses
202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

409

Conflict

post/api/v8/restorePoints/virtualMachines/diskSnapshots/rescan
Request samples 
curl -i -X POST \
  https://123.123.123.123/api/v8/restorePoints/virtualMachines/diskSnapshots/rescan \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "string",
  • "type": "BackupRetention",
  • "localizedType": "string",
  • "executionStartTime": "2019-08-24T14:15:22Z",
  • "executionStopTime": "2019-08-24T14:15:22Z",
  • "executionDuration": "string",
  • "status": "Canceled",
  • "backupJobInfo": {
    },
  • "healthCheckJobInfo": {
    },
  • "restoreJobInfo": {
    },
  • "fileLevelRestoreJobInfo": {
    },
  • "fileShareFileLevelRestoreJobInfo": {
    },
  • "repositoryJobInfo": {
    },
  • "restorePointDataRetrievalJobInfo": {
    },
  • "retentionJobInfo": {
    },
  • "_links": {}
}

Get Collection of Azure VM Snapshots

The HTTP GET request to the /restorePoints/virtualMachines/snapshots endpoint retrieves a list of snapshots of Azure VMs.

SecurityBearer
Request
query Parameters
RestorePointId
string or null <uuid>

Returns only snapshots associated with a restore point with the specified ID.

x-veeam-parameter-group: VirtualMachineSnapshotFilter
VirtualMachineId
string or null

Returns only snapshots of an Azure VM with the specified ID.

x-veeam-parameter-group: VirtualMachineSnapshotFilter
Offset
integer <int32> >= 0

Specifies the first N items of a resource collection that will be excluded from the response.

x-veeam-parameter-group: Veeam.Azure.REST.RequestQuery.V2.PageProperties
Limit
integer <int32> >= -1

Specifies the maximum number of items of a resource collection that will be returned in the response.

x-veeam-parameter-group: Veeam.Azure.REST.RequestQuery.V2.PageProperties
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

get/api/v8/restorePoints/virtualMachines/snapshots
Request samples 
curl -i -X GET \
  'https://123.123.123.123/api/v8/restorePoints/virtualMachines/snapshots?RestorePointId=497f6eca-6276-4993-bfeb-53cbbbba6f08&VirtualMachineId=string&Offset=0&Limit=-1' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "totalCount": 0,
  • "_links": {},
  • "results": [
    ]
}