This is an archive version of the document. To get the most up-to-date information, see the current version.Modify Backup Policy
You can update a backup policy with the specified ID.
Request
To update backup policy settings, send the HTTP PUT request to the /policies{policyId} endpoint. {policyId} is a system ID assigned to the backup policy in the Veeam Backup for AWS REST API.
HTTP Request
PUT https://<hostname>:<port>/api/v1/policies/{policyId} |
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 update the backup policy settings, send the parameters of the Policy schema in the request body.
Set the parameter values in the following format:
{ "id": "string($uuid)", "snapshotSettings": { "additionalTags": [ { "key": "string", "value": "string" } ], "copyTagsFromVolumeEnabled": true/false, "tryCreateVSSSnapshot": true/false }, "replicaSettings": { "mapping": [ { "sourceRegionId": "string($uuid)", "targetRegionId": "string($uuid)", "targetAmazonAccountId": "string($uuid)", "encryptionKey": "string" } ], "additionalTags": [ { "key": "string", "value": "string" } ], "copyTagsFromVolumeEnabled": true/false }, "backupSettings": { "targetRepositoryId": "string($uuid)" }, "regionIds": [ "string($uuid)" ], "selectedItems": { "virtualMachineIds": [ "string($uuid)" ], "tagIds": [ "string($uuid)" ] }, "excludedItems": { "virtualMachineIds": [ "string($uuid)" ], "tagIds": [ "string($uuid)" ] }, "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), "amazonAccountId": "string($uuid)", "retrySettings": { "retryTimes": integer($int32) }, "policyNotificationSettings": { "recipient": "string", "notifyOnSuccess": true/false, "notifyOnWarning": true/false, "notifyOnFailure": true/false }, "isEnabled": true/false, "backupType": "AllItems" } |
Response
The server returns the following response to the client.
Response Code
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 AWS returns a representation of the updated backup policy. The Policy schema is used for the resource representation.
Example
The following request updates a backup policy with the ID 406c92ee-7d88-47ab-9c35-d4099d137396.
|