Veeam Backup for Microsoft Azure 8
REST API Reference
Related documents

Azure VMs Protected by Veeam Backup for Microsoft Azure

The /protectedItem/virtualMachines resource collection represents Azure VMs protected by Veeam Backup for Microsoft Azure.

Get Collection of Protected Azure VMs

The HTTP GET request to the /protectedItem/virtualMachines endpoint retrieves a list of Azure VMs protected by Veeam Backup for Microsoft Azure.

SecurityBearer
Request
query Parameters
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
SearchPattern
string or null

Returns only those items of a resource collection that match the specified search pattern in the parameter value.

x-veeam-parameter-group: ProtectedItemOptions
Sync
boolean or null

Defines whether to force rescanning of the Microsoft Azure infrastructure before the response.

x-veeam-parameter-group: ProtectedItemOptions
FlrSession
boolean or null

Defines whether to return Azure VMs for which file-level recovery sessions are launched.

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

Returns only Azure VMs with the specified data retrieval status.

Enum: "None" "Retrieving" "Retrieved" "Unknown"
x-veeam-parameter-group: ProtectedItemOptions
Responses
200

OK

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

get/api/v8/protectedItem/virtualMachines
Request samples 
curl -i -X GET \
  'https://123.123.123.123/api/v8/protectedItem/virtualMachines?Offset=0&Limit=-1&SearchPattern=string&Sync=true&FlrSession=true&DataRetrievalStatuses=None' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "totalCount": 0,
  • "_links": {},
  • "results": [
    ]
}

Get Protected Azure VM Data

The HTTP GET request to the /protectedItem/virtualMachines/{id} endpoint retrieves information on a protected Azure VM with the specified ID.

SecurityBearer
Request
path Parameters
id
required
string or null

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

query Parameters
sync
boolean or null

Defines whether to force rescanning of the Microsoft Azure infrastructure before the response.

Responses
200

OK

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

get/api/v8/protectedItem/virtualMachines/{id}
Request samples 
curl -i -X GET \
  'https://123.123.123.123/api/v8/protectedItem/virtualMachines/{id}?sync=true' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "string",
  • "azureId": "string",
  • "name": "string",
  • "azureEnvironment": "Global",
  • "osType": "Windows",
  • "regionName": "string",
  • "totalSizeInGB": 0,
  • "vmSize": "string",
  • "availabilityZone": "string",
  • "isController": true,
  • "lastBackup": "2019-08-24T14:15:22Z",
  • "subscription": {
    },
  • "region": {
    },
  • "resourceGroup": {
    },
  • "_links": {}
}

Export Collection of Protected Azure VMs

The HTTP POST request to the /protectedItem/virtualMachines/export endpoint exports a list of Azure VMs protected by Veeam Backup for Microsoft Azure to a .CSV or an .XML file.

x-veeam-custom-response: true
SecurityBearer
Request
header Parameters
Accept
string or null

Specifies a media type of representation of the exported data. The default value is text/csv media type.

Request Body schema: application/json
virtualMachineIds
Array of strings or null

Specifies system IDs assigned in the Veeam Backup for Microsoft Azure REST API to protected Azure VMs information on which will be exported.

searchPattern
string or null

Exports only data on those items of a resource collection that match the specified search pattern in the parameter value.

flrSession
boolean or null

Defines whether to export data on Azure VMs for which file-level recovery sessions are launched.

dataRetrievalStatuses
Array of strings or null (DataRetrievalStatus)

Exports only data on Azure VMs with the specified data retrieval status.

Enum: "None" "Retrieving" "Retrieved" "Unknown"
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

409

Conflict

post/api/v8/protectedItem/virtualMachines/export
Request samples
application/json
{
  • "virtualMachineIds": [
    ],
  • "searchPattern": "string",
  • "flrSession": true,
  • "dataRetrievalStatuses": [
    ]
}
Response samples
application/problem+json
{
  • "extensions": { },
  • "status": 0,
  • "title": "string",
  • "detail": "string",
  • "type": "string"
}

Remove Backups of Protected Azure VM

The HTTP POST request to the /protectedItem/virtualMachines/{id}/deleteBackups endpoint deletes backups created for an Azure VM with the specified ID.

SecurityBearer
Request
path Parameters
id
required
string or null

Specifies the system ID assigned to an Azure VM in the Veeam Backup for Microsoft Azure REST API.

query Parameters
BackupTier
string (ProtectedDataBackupTier)

Specifies the type of the backups that will be deleted.

Enum: "NonArchive" "Archive" "Unknown" "All"
x-veeam-parameter-group: ProtectedDataDeleteOptions
Responses
202

Accepted

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

post/api/v8/protectedItem/virtualMachines/{id}/deleteBackups
Request samples 
curl -i -X POST \
  'https://123.123.123.123/api/v8/protectedItem/virtualMachines/{id}/deleteBackups?BackupTier=NonArchive' \
  -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": {}
}

Remove Snapshots of Protected Azure VM

The HTTP POST request to the /protectedItem/virtualMachines/{id}/deleteSnapshots endpoint deletes snapshots created for an Azure VM with the specified ID.

SecurityBearer
Request
path Parameters
id
required
string or null

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

Responses
202

Accepted

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

post/api/v8/protectedItem/virtualMachines/{id}/deleteSnapshots
Request samples 
curl -i -X POST \
  'https://123.123.123.123/api/v8/protectedItem/virtualMachines/{id}/deleteSnapshots' \
  -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": {}
}

Remove Backups of Protected Azure VMs

The HTTP POST request to the /protectedItem/virtualMachines/deleteBackups endpoint removes backups created for Azure VMs with the specified IDs.

SecurityBearer
Request
Request Body schema: application/json
required
ids
required
Array of strings <= 1000 items

Specifies a comma-separated list of system IDs assigned in the Veeam Backup for Microsoft Azure REST API to Azure VMs whose backups will be removed.

backupTier
string or null (ProtectedDataBackupTierNullable)

Defines whether you want to delete Archive, Standard (NonArchive) or All backups created for the specified Azure resources. By default, Veeam Backup for Microsoft Azure deletes all backups.

Enum: "NonArchive" "Archive" "Unknown" "All"
x-external-type: Veeam.Azure.REST.Latest.ProtectedDataBackupTier
Responses
202

Accepted

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

post/api/v8/protectedItem/virtualMachines/deleteBackups
Request samples
application/json
{
  • "ids": [
    ],
  • "backupTier": "NonArchive"
}
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": {}
}

Remove Snapshots of Protected Azure VMs

The HTTP POST request to the /protectedItem/virtualMachines/deleteSnapshots endpoint removes snapshots created for Azure VMs with the specified IDs.

SecurityBearer
Request
Request Body schema: application/json
required
ids
required
Array of strings

Specifies a comma-separated list of system IDs assigned in the Veeam Backup for Microsoft Azure REST API to Azure VMs whose snapshots will be removed.

Responses
202

Accepted

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

post/api/v8/protectedItem/virtualMachines/deleteSnapshots
Request samples
application/json
{
  • "ids": [
    ]
}
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": {}
}

Remove Manual Snapshots of Protected Azure VMs

The HTTP POST request to the /protectedItem/virtualMachines/deleteManualSnapshots endpoint deletes snapshots created manually for Azure VMs with the specified IDs.

SecurityBearer
Request
Request Body schema: application/json
required
ids
required
Array of strings

Specifies a comma-separated list of system IDs assigned in the Veeam Backup for Microsoft Azure REST API to Azure VMs whose snapshots will be removed.

Responses
202

Accepted

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

post/api/v8/protectedItem/virtualMachines/deleteManualSnapshots
Request samples
application/json
{
  • "ids": [
    ]
}
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": {}
}

Remove Manual Snapshots of Protected Azure VM

The HTTP POST request to the /protectedItem/virtualMachines/{id}/deleteManualSnapshots endpoint deletes snapshots created manually for an Azure VM with the specified ID.

SecurityBearer
Request
path Parameters
id
required
string or null

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

Responses
202

Accepted

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

post/api/v8/protectedItem/virtualMachines/{id}/deleteManualSnapshots
Request samples 
curl -i -X POST \
  'https://123.123.123.123/api/v8/protectedItem/virtualMachines/{id}/deleteManualSnapshots' \
  -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": {}
}