Veeam Backup for Microsoft Azure 8
REST API Reference
Related documents

Virtual Network Configuration Backup Policy

The /policy/vnet resource collection represents the virtual network configuration backup policy created by Veeam Backup for Microsoft Azure.

Get Virtual Network Configuration Backup Policy

The HTTP GET request to the /policy/vnet endpoint retrieves virtual network configuration backup policy created by Veeam Backup for Microsoft Azure.

SecurityBearer
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

get/api/v8/policy/vnet
Request samples 
curl -i -X GET \
  https://123.123.123.123/api/v8/policy/vnet \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "isEnabled": true,
  • "autoDiscoverSubscriptions": true,
  • "autoDiscoveredProtectedResources": [
    ],
  • "additionalProtectedResources": [
    ],
  • "nextExecutionTime": "2019-08-24T14:15:22Z",
  • "isScheduleConfigured": true,
  • "backupIntervalMinutes": 0,
  • "backupIntervalHours": 0,
  • "retentionPeriodDays": 0,
  • "retentionPeriodWeeks": 0,
  • "retentionPeriodMonths": 0,
  • "targetRepositoryId": "string",
  • "policyNotificationSettings": {
    },
  • "_links": {}
}

Modify Virtual Network Configuration Backup Policy

The HTTP PUT request to the /policy/vnet endpoint updates settings of the virtual network configuration backup policy.

SecurityBearer
Request
Request Body schema: application/json
required
isEnabled
required
boolean or null

Defines whether to enable the policy.

autoDiscoverSubscriptions
required
boolean or null

Defines whether to protect virtual network configuration of all Azure subscriptions specified in Azure VM, Azure SQL and Azure file share backup policy settings.

backupIntervalMinutes
integer or null <int32> [ 5 .. 60 ]

Time interval (in minutes) at which the backup policy will run.

backupIntervalHours
integer or null <int32> [ 1 .. 24 ]

Time interval (in hours) at which the backup policy will run.

retentionPeriodDays
integer or null <int32> [ 1 .. 365 ]

Time period (in days) for which the backups will be stored in the Veeam Backup for Microsoft Azure configuration database.

retentionPeriodWeeks
integer or null <int32> [ 1 .. 52 ]

Time period (in weeks) for which the backups will be stored in the Veeam Backup for Microsoft Azure configuration database.

retentionPeriodMonths
integer or null <int32> [ 1 .. 12 ]

Time period (in months) for which the backups will be stored in the Veeam Backup for Microsoft Azure configuration database.

targetRepositoryId
string or null

System ID assigned to the repository in the Veeam Backup for Microsoft Azure REST API.

Array of objects or null (VnetPolicyAdditionalProtectedResourcesFromClient)

Information on a service account whose permissions will be used to perform virtual network configuration backup, and on the subscriptions that will be protected by the virtual network configuration backup policy.

object or null (PolicyNotificationSettings)

Specifies the notification settings for the backup policy.

Responses
204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

415

Client Error

put/api/v8/policy/vnet
Request samples
application/json
{
  • "isEnabled": true,
  • "autoDiscoverSubscriptions": true,
  • "backupIntervalMinutes": 5,
  • "backupIntervalHours": 1,
  • "retentionPeriodDays": 1,
  • "retentionPeriodWeeks": 1,
  • "retentionPeriodMonths": 1,
  • "targetRepositoryId": "string",
  • "additionalProtectedResources": [
    ],
  • "policyNotificationSettings": {
    }
}
Response samples
application/problem+json
{
  • "extensions": { },
  • "status": 0,
  • "title": "string",
  • "detail": "string",
  • "type": "string"
}

Start Virtual Network Configuration Backup Policy

The HTTP POST request to the /policy/vnet/start endpoint launches a virtual network configuration backup policy.

SecurityBearer
Responses
202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

409

Conflict

post/api/v8/policy/vnet/start
Request samples 
curl -i -X POST \
  https://123.123.123.123/api/v8/policy/vnet/start \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
[
  • {
    }
]

Stop Virtual Network Configuration Backup Policy

The HTTP POST request to the /policy/vnet/stop endpoint stops execution of the virtual network configuration backup policy.

SecurityBearer
Responses
204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

post/api/v8/policy/vnet/stop
Request samples 
curl -i -X POST \
  https://123.123.123.123/api/v8/policy/vnet/stop \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/problem+json
{
  • "detail": "string",
  • "errors": {
    },
  • "status": 0,
  • "title": "string",
  • "traceId": "string",
  • "type": "string"
}

Enable Virtual Network Configuration Backup Policy

The HTTP POST request to the /policy/vnet/enable endpoint enables a disabled virtual network configuration backup policy.

SecurityBearer
Responses
204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

post/api/v8/policy/vnet/enable
Request samples 
curl -i -X POST \
  https://123.123.123.123/api/v8/policy/vnet/enable \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/problem+json
{
  • "detail": "string",
  • "errors": {
    },
  • "status": 0,
  • "title": "string",
  • "traceId": "string",
  • "type": "string"
}

Disable Virtual Network Configuration Backup Policy

The HTTP POST request to the /policy/vnet/disable endpoint disables an enabled virtual network configuration backup policy.

SecurityBearer
Responses
204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

post/api/v8/policy/vnet/disable
Request samples 
curl -i -X POST \
  https://123.123.123.123/api/v8/policy/vnet/disable \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/problem+json
{
  • "detail": "string",
  • "errors": {
    },
  • "status": 0,
  • "title": "string",
  • "traceId": "string",
  • "type": "string"
}

Export Virtual Network Configuration Backup Policy

The HTTP POST request to the /policy/vnet/export endpoint exports the virtual network configuration backup policy created 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.

Responses
200

OK

401

Unauthorized

403

Forbidden

post/api/v8/policy/vnet/export
Request samples 
curl -i -X POST \
  https://123.123.123.123/api/v8/policy/vnet/export \
  -H 'Accept: string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/problem+json
{
  • "extensions": { },
  • "status": 0,
  • "title": "string",
  • "detail": "string",
  • "type": "string"
}