Create Backup Policy
You can create a new backup policy.
Request
To create a backup policy, send the HTTP POST request to the /policies endpoint.
HTTP Request
POST https://<hostname>/api/v2/policies |
Request Headers
The request contains the following headers.
Header | Required | Value | Description |
|---|---|---|---|
Authorization | Required | Bearer <Access-Token> | Authenticates a client who sends the request to the server. Must contain the access token for the current logon session in the Bearer <Access-Token> format. |
Request Body
To create the backup policy, send the parameters of the PolicyV2 schema in the request body.
Set the parameter values in the following format:
{ "regions": [ { "regionId": "string" } ], "selectedItems": { "subscriptions": [ { "subscriptionId": "string" } ], "tags": [ { "name": "string", "value": "string" } ], "resourceGroups": [ { "id": "string" } ], "virtualMachines": [ { "id": "string" } ] }, "excludedItems": { "virtualMachines": [ { "id": "string" } ] }, "name": "string", "description": "string", "tenantId": "string", "retrySettings": { "retryCount": 0 }, "policyNotificationSettings": { "recipient": "string", "notifyOnSuccess": true, "notifyOnWarning": true, "notifyOnFailure": true }, "isEnabled": true, "backupType": "AllSubscriptions", "snapshotSettings": { "additionalTags": [ { "name": "string", "value": "string" } ], "copyOriginalTags": true, "applicationAwareSnapshot": true, "userScripts": { "windows": { "scriptsEnabled": true, "preScriptPath": "string", "preScriptArguments": "string", "postScriptPath": "string", "postScriptArguments": "string", "repositorySnapshotsOnly": true, "ignoreExitCodes": true, "ignoreMissingScripts": true }, "linux": { "scriptsEnabled": true, "preScriptPath": "string", "preScriptArguments": "string", "postScriptPath": "string", "postScriptArguments": "string", "repositorySnapshotsOnly": true, "ignoreExitCodes": true, "ignoreMissingScripts": true } } }, "dailySchedule": { "dailyType": "Everyday", "selectedDays": [ "Sunday" ], "runsPerHour": 0, "snapshotSchedule": { "hours": [ 0 ], "snapshotsToKeep": 0 }, "backupSchedule": { "hours": [ 0 ], "retention": { "timeRetentionDuration": 0, "retentionDurationType": "Days" }, "targetRepositoryId": "string" } }, "weeklySchedule": { "startTime": 0, "snapshotSchedule": { "selectedDays": [ "Sunday" ], "snapshotsToKeep": 0 }, "backupSchedule": { "selectedDays": [ "Sunday" ], "retention": { "timeRetentionDuration": 0, "retentionDurationType": "Days" }, "targetRepositoryId": "string" } }, "monthlySchedule": { "startTime": 0, "type": "First", "dayOfWeek": "Sunday", "dayOfMonth": 0, "monthlyLastDay": true, "snapshotSchedule": { "selectedMonths": [ "January" ], "snapshotsToKeep": 0 }, "backupSchedule": { "selectedMonths": [ "January" ], "retention": { "timeRetentionDuration": 0, "retentionDurationType": "Days" }, "targetRepositoryId": "string" } }, "yearlySchedule": { "startTime": 0, "month": "January", "type": "First", "dayOfWeek": "Sunday", "dayOfMonth": 0, "yearlyLastDay": true, "retentionYearsCount": 0, "targetRepositoryId": "string" } } |
Response
The server returns the following response to the client.
Response Codes
A successfully completed operation returns a response code 200 (OK).
Response Headers
The response to this request contains the following headers. The response may also include additional standard HTTP headers.
Header | Value | Description |
|---|---|---|
Content-length | integer | Identifies the length of the response body message, in bytes. |
Content-type |
| Identifies the media type of the response body message. |
Response Body
In the response body, Veeam Backup for Microsoft Azure returns a representation of the created backup policy. The PolicyV2 schema is used for the resource representation.
Example
The following request creates a backup policy with the following settings.
|