Veeam Backup for Microsoft Azure 8
REST API Reference
Related documents

Virtual Network Configuration Restore Points

The /restorePoints/vnets resource collection represents restore points of virtual network configurations available in Veeam Backup for Microsoft Azure.

Get Virtual Network Configuration Restore Points

The HTTP GET request to the /restorePoints/vnets endpoint retrieves a list of restore points created for virtual network configurations in the Veeam Backup for Microsoft Azure configuration database.

SecurityBearer
Request
query Parameters
RegionId
string or null

Returns only restore points created in Azure regions with the specified IDs.

x-veeam-parameter-group: VnetRestorePointSearchOptions
SubscriptionId
string or null

Returns only restore points created for Azure subscriptions with the specified IDs.

x-veeam-parameter-group: VnetRestorePointSearchOptions
BackupDestinations
Array of strings or null (VnetBackupDestination)

Returns only restore points with the specified backup destinations.

Enum: "None" "Database" "AzureBlob" "All"
x-veeam-parameter-group: VnetRestorePointSearchOptions
OnlyLatest
boolean

Defines whether to return only recently created restore points.

x-veeam-parameter-group: VnetRestorePointSearchOptions
PointInTime
string or null <date-time>
x-veeam-parameter-group: VnetRestorePointSearchOptions
Offset
integer <int32> >= 0

Specifies the first N items 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 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/vnets
Request samples 
curl -i -X GET \
  'https://123.123.123.123/api/v8/restorePoints/vnets?RegionId=string&SubscriptionId=string&BackupDestinations=None&OnlyLatest=true&PointInTime=2019-08-24T14%3A15%3A22Z&Offset=0&Limit=-1' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "totalCount": 0,
  • "_links": {},
  • "results": [
    ]
}

Get Virtual Network Configuration Restore Point Data

The HTTP GET request to the /restorePoints/vnets/{restorePointId} endpoint retrieves information on a specific virtual network configuration restore point created for 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
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

get/api/v8/restorePoints/vnets/{restorePointId}
Request samples 
curl -i -X GET \
  'https://123.123.123.123/api/v8/restorePoints/vnets/{restorePointId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "Full",
  • "vbrId": "string",
  • "azureAccountId": "string",
  • "subscriptionId": "string",
  • "subscriptionName": "string",
  • "regionId": "string",
  • "regionName": "string",
  • "pointInTime": "2019-08-24T14:15:22Z",
  • "gfsFlags": "string",
  • "jobSessionId": "string",
  • "backupDestination": "None",
  • "sizeInBytes": 0,
  • "isCorrupted": true,
  • "latestChainSizeBytes": 0,
  • "changes": "string",
  • "_links": {}
}

Compare Virtual Network Configuration Restore Point Backups

The HTTP GET request to the /restorePoints/vnets/{restorePointId}/compareWithProduction endpoint allows you to compare the current Azure virtual network configuration to the backed-up virtual network configuration data from the 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.

query Parameters
OnlyDifferent
boolean

Defines whether to return only backed-up virtual network configuration items that differ from the current virtual network configuration items.

x-veeam-parameter-group: VnetCompareWithProductionOptions
RegionId
string or null

Returns only results for an Azure region with the specified ID.

x-veeam-parameter-group: VnetCompareWithProductionOptions
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

get/api/v8/restorePoints/vnets/{restorePointId}/compareWithProduction
Request samples 
curl -i -X GET \
  'https://123.123.123.123/api/v8/restorePoints/vnets/{restorePointId}/compareWithProduction?OnlyDifferent=true&RegionId=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
[
  • {
    }
]

Restore Virtual Network Configuration

The HTTP POST request to the /restorePoints/vnets/{restorePointId}/restore endpoint restores virtual network configuration items using the 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
serviceAccountId
required
string <uuid>

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.

sourceRegion
required
string

Specifies the system ID assigned in the Veeam Backup for Microsoft Azure REST API to an Azure region whose network configuration items you want to restore.
Note: This parameter is required.

restoreType
required
string (VnetRestorePointRestoreType)

Defines whether to restore the entire virtual network configuration to the original location, to restore the entire virtual network configuration to a custom location, or to restore specific virtual network configuration items to the original location.
Note: This parameter is required.

Enum: "Unknown" "ToOriginal" "ToDifferent" "SelectedItems"
reason
string

Specifies a reason for performing the restore operation.

resourceIdsToRestore
Array of strings or null

[Applies only if the SelectedItems value has been specified for the VnetRestorePointRestoreType parameter] Specifies the Azure IDs assigned to virtual network configuration items that will be restored.

object or null (VnetToAlternativeRestoreOptions)

[Applies only if the ToDifferent value has been specified for the VnetRestorePointRestoreType parameter] Specifies the settings configured when restoring to a new location or with different settings.

Responses
202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

post/api/v8/restorePoints/vnets/{restorePointId}/restore
Request samples
application/json
{
  • "reason": "string",
  • "serviceAccountId": "a814cf67-aaac-43ae-acb4-8d34e82a4b4c",
  • "resourceIdsToRestore": [
    ],
  • "restoreType": "Unknown",
  • "toAlternative": {
    },
  • "sourceRegion": "string"
}
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 Virtual Network Configuration Restore Point Regions by Subscription

The HTTP GET request to the /restorePoints/vnetRegions/{subscriptionId} endpoint retrieves all Azure regions where Veeam Backup for Microsoft Azure created virtual network configuration restore points for an Azure subscription with the specified ID.

SecurityBearer
Request
path Parameters
subscriptionId
required
string <uuid>

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

query Parameters
Offset
integer <int32> >= 0

Specifies the first N items 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 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

404

Not Found

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