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

Get Backup Policy Data

You can get details of a backup policy with the specified ID.

Request

To retrieve information on a specific backup policy, send the HTTP GET 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

GET 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.
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 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	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 a representation of the backup policy with the specified ID. The Policy schema is used for the resource representation.

Get Backup Policy Data Example

The following request returns information on a 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

Request Header:

Authorization: Bearer <Access-Token>

x-api-version: 1.0-rev0

Response:

200

Response Body:

{

"backupType": "SelectedItems",

"id": "6ac40b80-4bdb-46e9-9759-0fc0d1166ccf",

"snapshotSettings": {

"additionalTags": [

{

"key": "policy",

"value": "dept01"

}

"copyTagsFromVolumeEnabled": true,

"tryCreateVSSSnapshot": true

"replicaSettings": {

"mapping": [

{

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

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

"targetAmazonAccountId": "d98f4d37-7874-4be1-9702-770078f5c9cd",

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

{

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

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

"targetAmazonAccountId": "d98f4d37-7874-4be1-9702-770078f5c9cd",

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

}

"additionalTags": [

{

"key": "policy",

"value": "dept01"

}

"copyTagsFromVolumeEnabled": true

"backupSettings": {

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

"regionIds": [

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

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

"selectedItems": {

"virtualMachineIds": [

"2c9e17f0-6690-41a3-aa95-f5e824bf4307",

"c27fdf69-2761-4e31-a768-6576291018e5"

"tagIds": [

"1f3b938b-7ef9-4857-95d7-4ff8d0104e4f"

]

"excludedItems": {

"virtualMachineIds": [],

"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,

false

]

}

"backupOptions": {

"retention": {

"type": "Days",

"count": 21

"schedule": {

"hours": [

false,

true,

false,

false

]

}

"replicaOptions": {

"retention": {

"count": 7

"schedule": {

"hours": [

false,

true,

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,

"amazonAccountId": "d98f4d37-7874-4be1-9702-770078f5c9cd",

"retrySettings": {

"retryTimes": 3

"policyNotificationSettings": {

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

"notifyOnSuccess": true,

"notifyOnWarning": true,

"notifyOnFailure": true

"isEnabled": true,

"createdBy": "administrator",

"modifiedBy": "administrator",

"usn": 114947,

"_embeddedResources": {

"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/6ac40b80-4bdb-46e9-9759-0fc0d1166ccf/selectedItems"

"excludedResources": {

"method": "GET",

"rel": "ExcludedItems",

"href": "https://135.169.170.192:11005/api/v1/policies/6ac40b80-4bdb-46e9-9759-0fc0d1166ccf/excludedItems"

"regions": {

"method": "GET",

"rel": "Regions",

"href": "https://135.169.170.192:11005/api/v1/policies/6ac40b80-4bdb-46e9-9759-0fc0d1166ccf/regions"

}

"_links": [

{

"method": "GET",

"rel": "self",

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

{

"method": "PUT",

"rel": "update",

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

{

"method": "DELETE",

"rel": "delete",

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

{

"method": "POST",

"rel": "disable",

"href": "https://135.169.170.192:11005/api/v1/policies/6ac40b80-4bdb-46e9-9759-0fc0d1166ccf/disable"

}

]

}