Veeam Backup for Microsoft Azure 8
REST API Reference
Related documents

Virtual Network Configuration Protected by Veeam Backup for Microsoft Azure

The /protectedItem/vnet resource collection represents the virtual network configuration protected by Veeam Backup for Microsoft Azure.

Get Collection of Protected Azure Virtual Networks

The HTTP GET request to the /protectedItem/vnet endpoint retrieves a list of virtual networks whose configurations are protected by Veeam Backup for Microsoft Azure to a .CSV or an .XML file.

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
BackupDestinations
Array of strings or null (VnetBackupDestination)

Returns only virtual networks whose configurations were backed up to the specified destinations.

Enum: "None" "Database" "AzureBlob" "All"
x-veeam-parameter-group: ProtectedVnetOptions
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

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

Remove Virtual Network Configuration Restore Points

The HTTP POST request to the /protectedItem/vnet/delete endpoint removes from the Veeam Backup for Microsoft Azure configuration database all the restore points of the virtual network configuration of an Azure subscription with the specified ID.

SecurityBearer
Request
Request Body schema: application/json
required
subscriptionId
required
string or null <uuid>

Specifies the Microsoft Azure ID assigned to a subscription whose virtual network configuration restore points will be removed from the Veeam Backup for Microsoft Azure configuration database.

deletionType
required
string (VnetDeletionType)

Specifies the type of backups that will be removed.

Enum: "Backup" "BackupCopy" "All"
Responses
202

Accepted

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

post/api/v8/protectedItem/vnet/delete
Request samples
application/json
{
  • "subscriptionId": "d079718b-ff63-45dd-947b-4950c023750f",
  • "deletionType": "Backup"
}
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": {}
}

Export Collection of Protected Azure Virtual Networks

The HTTP POST request to the /protectedItem/vnet/export endpoint exports a list of virtual networks whose configurations are 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
restorePointIds
Array of strings or null <uuid>

Specifies system IDs assigned in the Veeam Backup for Microsoft Azure REST API to the virtual network configuration restore points whose data 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.

Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

409

Conflict

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

Import Virtual Network Configuration Backup Copies

The HTTP POST request to the /protectedItem/vnet/import endpoint imports all virtual network configuration backup copies stored in backup repositories to the Veeam Backup for Microsoft Azure configuration database.

SecurityBearer
Responses
202

Accepted

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

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