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

Export Backup Policy Settings

You can export backup policy settings for future reference.

Request

To export backup policy settings, send the HTTP GET request to the /policies/{policyId}/export endpoint. {policyId} is a system ID assigned to the backup policy in the Veeam Backup for AWS REST API.

HTTP Request

GET https://<hostname>:<port>/api/v1/policies/{policyId}/export

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.

Accept

Optional

  • application/json
  • application/problem+json

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.

Response

The server returns the following response to the client.

Response Code

A successfully completed operation returns a response code 201 (Created).

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

  • application/json
  • application/problem+json

Identifies the media type of the response body message.

Response Body

In the response body, Veeam Backup for AWS returns exported details of the backup policy with the specified ID. The PolicyExportModel schema is used for the resource representation.

Export Backup Policy SettingsExample

The following request exports settings of the backup policy with the ID 6ac40b80-4bdb-46e9-9759-0fc0d1166ccf.

Request:

GET https://135.169.170.192:11005/api/v1/policies/6ac40b80-4bdb-46e9-9759-0fc0d1166ccf/export

 

Request Header:

Authorization: Bearer <Access-Token>

x-api-version: 1.0-rev0

 

Response:

201

 

Response Body:

{

 "backupType": "SelectedItems",

 "snapshotSettings": {

   "additionalTags": [

     {

       "key": "policy",

       "value": "dept01"

     }

   ],

   "copyTagsFromVolumeEnabled": true,

   "tryCreateVSSSnapshot": true

 },

 "replicaSettings": {

   "mapping": [

     {

       "sourceRegionName": "eu-central-1",

       "targetRegionName": "eu-west-2",

       "targetAmazonAccountName": "Default Backup Restore",

       "encryptionKey": "arn:aws:kms:eu-west-2:534095521853:key/8c18bc6a-18f6-4f61-8f89-970cd263e653"

     },

     {

       "sourceRegionName": "us-east-2",

       "targetRegionName": "eu-west-2",

       "targetAmazonAccountName": "Default Backup Restore",

       "encryptionKey": "arn:aws:kms:eu-west-2:534095521853:key/8c18bc6a-18f6-4f61-8f89-970cd263e653"

     }

   ],

   "additionalTags": [

     {

       "key": "policy",

       "value": "dept01"

     }

   ],

   "copyTagsFromVolumeEnabled": true

 },

 "backupSettings": {

   "targetRepositoryName": "Repository 01"

 },

 "regions": [

   "eu-central-1",

   "us-east-2"

 ],

 "selectedItems": {

   "virtualMachines": [

     "i-0b176a996234da1c0",

     "i-048f047b0ab11dd92"

   ],

   "tags": [

     {

       "key": "Name",

       "value": "2016abor2"

     }

   ]

 },

 "excludedItems": {

   "virtualMachines": [],

   "tags": []

 },

 "scheduleSettings": {

   "dailyScheduleEnabled": true,

   "dailySchedule": {

     "kind": "Everyday",

     "runsPerHour": 1,

     "days": [

       "Sunday",

       "Monday",

       "Tuesday",

       "Wednesday",

       "Thursday",

       "Friday",

       "Saturday"

     ],

     "snapshotOptions": {

       "retention": {

         "count": 7

       },

       "schedule": {

         "hours": [

           false,

           false,

           false,

           false,

           false,

           false,

           false,

           false,

           false,

           false,

           false,

           false,

           true,

           true,

           true,

           false,

           false,

           false,

           false,

           false,

           false,

           false,

           false,

           false

         ]

       }

     },

     "backupOptions": {

       "retention": {

         "type": "Days",

         "count": 21

       },

       "schedule": {

         "hours": [

           false,

           false,

           false,

           false,

           false,

           false,

           false,

           false,

           false,

           false,

           false,

           false,

           false,

           false,

           true,

           false,

           false,

           false,

           false,

           false,

           false,

           false,

           false,

           false

         ]

       }

     },

     "replicaOptions": {

       "retention": {

         "count": 7

       },

       "schedule": {

         "hours": [

           false,

           false,

           false,

           false,

           false,

           false,

           false,

           false,

           false,

           false,

           false,

           false,

           false,

           true,

           false,

           false,

           false,

           false,

           false,

           false,

           false,

           false,

           false,

           false

         ]

       }

     }

   },

   "weeklyScheduleEnabled": true,

   "weeklySchedule": {

     "timeLocal": "2020-06-20T12:00:00",

     "snapshotOptions": {

       "retention": {

         "count": 7

       },

       "schedule": {

         "days": [

           "Monday",

           "Thursday",

           "Saturday"

         ]

       }

     },

     "backupOptions": {

       "retention": {

         "type": "Days",

         "count": 21

       },

       "schedule": {

         "days": [

           "Thursday",

           "Saturday"

         ]

       }

     },

     "replicaOptions": {

       "retention": {

         "count": 7

       },

       "schedule": {

         "days": [

           "Monday",

           "Thursday"

         ]

       }

     }

   },

   "monthlyScheduleEnabled": true,

   "monthlySchedule": {

     "dayNumberInMonth": "First",

     "dayOfWeek": "Monday",

     "timeLocal": "2020-06-20T12:00:00",

     "dayOfMonth": 1,

     "snapshotOptions": {

       "retention": {

         "count": 7

       },

       "schedule": {

         "months": [

           "January",

           "May",

           "August"

         ]

       }

     },

     "backupOptions": {

       "retention": {

         "type": "Months",

         "count": 6

       },

       "schedule": {

         "months": [

           "August"

         ]

       }

     },

     "replicaOptions": {

       "retention": {

         "count": 7

       },

       "schedule": {

         "months": [

           "May"

         ]

       }

     }

   },

   "yearlyScheduleEnabled": true,

   "yearlySchedule": {

     "dayNumberInMonth": "First",

     "dayOfWeek": "Monday",

     "month": "January",

     "timeLocal": "2020-06-20T12:00:00",

     "retention": {

       "type": "Years",

       "count": 100

     }

   }

 },

 "name": "Dept-01 Backup Policy",

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

 "priority": 4,

 "amazonAccountName": "Default Backup Restore",

 "retrySettings": {

   "retryTimes": 3

 },

 "policyNotificationSettings": {

   "recipient": "sara_baker@company.mail",

   "notifyOnSuccess": true,

   "notifyOnWarning": true,

   "notifyOnFailure": true

 },

 "isEnabled": true

}