This is an archive version of the document. To get the most up-to-date information, see the current version.

Backup Policies

The /policies resource collection represents all backup policies created in Veeam Backup for AWS.

Collection URL

The resource collection is located at the following URL:

https://<hostname>:<port>/api/v1/policies

Backup Policies Collection Representation

{

"backupType": "SelectedItems",

"id": "f07b89b0-2dd0-464f-ba9c-7950ee46de96",

"snapshotSettings": {

"additionalTags": [

{

"key": "role",

"value": "test"

}

"copyTagsFromVolumeEnabled": true,

"tryCreateVSSSnapshot": true

"replicaSettings": {

"mapping": [

{

"sourceRegionId": "dd4bfe66-f671-4797-9228-1b779a24654b",

"targetRegionId": "46ecc0f7-cbb8-496e-a2d3-808c06e1360a",

"targetAmazonAccountId": "eca01dcc-d324-4017-92cb-04ec240aaf0a",

"encryptionKey": "arn:aws:kms:eu-west-2:534095521853:key/10d0b4e1-3bbf-49c2-8f95-eb206fa92f7c"

{

"sourceRegionId": "a78f0156-7e78-4585-86ec-5cc590409def",

"targetRegionId": "46ecc0f7-cbb8-496e-a2d3-808c06e1360a",

"targetAmazonAccountId": "eca01dcc-d324-4017-92cb-04ec240aaf0a",

"encryptionKey": "arn:aws:kms:eu-west-2:534095521853:key/10d0b4e1-3bbf-49c2-8f95-eb206fa92f7c"

{

"sourceRegionId": "b7ec414c-dff8-467a-8dd9-fa52e5d684f8",

"targetRegionId": "46ecc0f7-cbb8-496e-a2d3-808c06e1360a",

"targetAmazonAccountId": "eca01dcc-d324-4017-92cb-04ec240aaf0a",

"encryptionKey": "arn:aws:kms:eu-west-2:534095521853:key/10d0b4e1-3bbf-49c2-8f95-eb206fa92f7c"

}

"additionalTags": [

{

"key": "role",

"value": "test"

}

"copyTagsFromVolumeEnabled": true

"backupSettings": {

"targetRepositoryId": "a7bcabe6-91f7-40ca-ad73-915d43a8e86b"

"regionIds": [

"a78f0156-7e78-4585-86ec-5cc590409def",

"b7ec414c-dff8-467a-8dd9-fa52e5d684f8",

"dd4bfe66-f671-4797-9228-1b779a24654b"

"selectedItems": {

"virtualMachineIds": [

"055cc961-554b-4248-a285-14d9ba96caf1",

"89e29fe8-74fb-4d09-b03b-6f2a48d860ef"

"tagIds": [

"735efeab-bc75-4273-8f0b-09b22e67067d"

]

"excludedItems": {

"virtualMachineIds": [

"407cc6cd-54cc-45e6-bfc1-1ae505bdf4c2"

"tagIds": []

"scheduleSettings": {

"dailyScheduleEnabled": true,

"dailySchedule": {

"kind": "Everyday",

"runsPerHour": 1,

"days": [

"Sunday",

"Monday",

"Tuesday",

"Wednesday",

"Thursday",

"Friday",

"Saturday"

"snapshotOptions": {

"retention": {

"count": 7

"schedule": {

"hours": [

false,

true,

false,

true,

false,

true,

false,

false

]

}

"backupOptions": {

"retention": {

"type": "Days",

"count": 21

"schedule": {

"hours": [

false,

true,

false,

false

]

}

"replicaOptions": {

"retention": {

"count": 7

"schedule": {

"hours": [

false,

true,

false,

false

]

}

"weeklyScheduleEnabled": false,

"monthlyScheduleEnabled": false,

"yearlyScheduleEnabled": false

"name": "Snapshot + Replica + S3 Backup",

"description": "Backup policy for Dept-01",

"priority": 3,

"amazonAccountId": "eca01dcc-d324-4017-92cb-04ec240aaf0a",

"retrySettings": {

"retryTimes": 3

"policyNotificationSettings": {

"recipient": "john.smith@company.com",

"notifyOnSuccess": true,

"notifyOnWarning": true,

"notifyOnFailure": true

"isEnabled": true,

"createdBy": "administrator",

"modifiedBy": "administrator",

"usn": 49523,

"_embeddedResources": {

"lastBackupSession": {

"method": "GET",

"rel": "LastSession",

"href": "https://135.169.170.192:11005/api/v1/sessions/abfe29c2-6440-4a66-b3c4-6acb4f7b6ef4"

"lastFinishedBackupSession": {

"method": "GET",

"rel": "LastFinishedSession",

"href": "https://135.169.170.192:11005/api/v1/sessions/5b82a697-e9b5-4e7e-9c0a-73be7d6fe9aa"

"targetRepository": {

"method": "GET",

"rel": "TargetRepository",

"href": "https://135.169.170.192:11005/api/v1/repositories/a7bcabe6-91f7-40ca-ad73-915d43a8e86b"

"protectedResources": {

"method": "GET",

"rel": "SelectedItems",

"href": "https://135.169.170.192:11005/api/v1/policies/f07b89b0-2dd0-464f-ba9c-7950ee46de96/selectedItems"

"excludedResources": {

"method": "GET",

"rel": "ExcludedItems",

"href": "https://135.169.170.192:11005/api/v1/policies/f07b89b0-2dd0-464f-ba9c-7950ee46de96/excludedItems"

"regions": {

"method": "GET",

"rel": "Regions",

"href": "https://135.169.170.192:11005/api/v1/policies/f07b89b0-2dd0-464f-ba9c-7950ee46de96/regions"

}

"_links": [

{

"method": "GET",

"rel": "self",

"href": "https://135.169.170.192:11005/api/v1/policies/f07b89b0-2dd0-464f-ba9c-7950ee46de96"

{

"method": "PUT",

"rel": "update",

"href": "https://135.169.170.192:11005/api/v1/policies/f07b89b0-2dd0-464f-ba9c-7950ee46de96"

{

"method": "DELETE",

"rel": "delete",

"href": "https://135.169.170.192:11005/api/v1/policies/f07b89b0-2dd0-464f-ba9c-7950ee46de96"

{

"method": "POST",

"rel": "disable",

"href": "https://135.169.170.192:11005/api/v1/policies/f07b89b0-2dd0-464f-ba9c-7950ee46de96/disable"

}

]

}

In This Section