This is an archive version of the document. To get the most up-to-date information, see the current version.Import Backup Policy Settings
You can import backup policy settings to create a new backup policy.
Request
To create a backup policy with imported settings, send the HTTP POST request to the /policies/import endpoint.
HTTP Request
POST https://<hostname>:<port>/api/v1/policies/import |
Request Headers
The request contains the following headers.
Header | Required/Optional | 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. |
x-api-version | Required | 1.0-rev0 | Specifies the current revision of the Veeam Backup for AWS REST API. |
Content-Type | Required | application/json | Identifies a media type that is used in the body of the request. |
Accept | Optional |
| Specifies a media type of representation that is required in the response message. If the requested type is not supported, the server will return the response in the application/json media type. |
Request Body
To import the backup policy, send settings using the PolicyExportModel schema in the request body.
Set the parameter values in the following format:
{ "snapshotSettings": { "additionalTags": [ { "key": "string", "value": "string" } ], "copyTagsFromVolumeEnabled": true/false, "tryCreateVSSSnapshot": true/false }, "replicaSettings": { "mapping": [ { "sourceRegionName": "string", "targetRegionName": "string", "targetAmazonAccountName": "string", "encryptionKey": "string" } ], "additionalTags": [ { "key": "string", "value": "string" } ], "copyTagsFromVolumeEnabled": true/false }, "backupSettings": { "targetRepositoryName": "string" }, "regions": [ "string" ], "selectedItems": { "virtualMachines": [ "string" ], "tags": [ { "key": "string", "value": "string" } ] }, "excludedItems": { "virtualMachines": [ "string" ], "tags": [ { "key": "string", "value": "string" } ] }, "scheduleSettings": { "dailyScheduleEnabled": true/false, "dailySchedule": { "kind": "Everyday", "runsPerHour": integer($int32), "days": [ "Sunday" ], "snapshotOptions": { "retention": { "count": integer($int32) }, "schedule": { "hours": [ true ] } }, "backupOptions": { "retention": { "type": "Days", "count": integer($int32) }, "schedule": { "hours": [ true ] } }, "replicaOptions": { "retention": { "count": integer($int32) }, "schedule": { "hours": [ true ] } } }, "weeklyScheduleEnabled": true/false, "weeklySchedule": { "timeLocal": "string($date-time)", "snapshotOptions": { "retention": { "count": integer($int32) }, "schedule": { "days": [ "Sunday" ] } }, "backupOptions": { "retention": { "type": "Days", "count": integer($int32) }, "schedule": { "days": [ "Sunday" ] } }, "replicaOptions": { "retention": { "count": integer($int32) }, "schedule": { "days": [ "Sunday" ] } } }, "monthlyScheduleEnabled": true/false, "monthlySchedule": { "timeLocal": "string($date-time)", "dayNumberInMonth": "First", "dayOfWeek": "Sunday", "dayOfMonth": integer($int32), "snapshotOptions": { "retention": { "count": integer($int32) }, "schedule": { "months": [ "January" ] } }, "backupOptions": { "retention": { "type": "Days", "count": integer($int32) }, "schedule": { "months": [ "January" ] } }, "replicaOptions": { "retention": { "count": integer($int32) }, "schedule": { "months": [ "January" ] } } }, "yearlyScheduleEnabled": true/false, "yearlySchedule": { "timeLocal": "string($date-time)", "dayNumberInMonth": "First", "dayOfWeek": "Sunday", "dayOfMonth": integer($int32), "month": "January", "retention": { "count": integer($int32), "type": "Years" } } }, "name": "string", "description": "string", "priority": integer($int64), "amazonAccountName": "string", "retrySettings": { "retryTimes": integer($int32) }, "policyNotificationSettings": { "recipient": "string", "notifyOnSuccess": true/false, "notifyOnWarning": true/false, "notifyOnFailure": true/false }, "isEnabled": true, "backupType": "AllItems" } |
Response
The server returns the following response to the client.
Response Code
A successfully completed operation returns a response code 202 (Accepted).
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 AWS returns the session ID of the importing the backup policy operation. For the session log details, see Get Session Log Details.
Example
The following request imports backup policy settings with only daily schedule enabled to create a new backup policy.
|