Get Backup Policies 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 Microsoft Azure REST API.

HTTP Request

GET https://<hostname>/api/v2/policies/{policyId}

Request Headers

The request contains the following headers.

Header

Required

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.

Response

The server returns the following response to the client.

Response Codes

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

Get Backup Policies DataExample

The following request returns information on a backup policy with the ID a1c3b4cb-29d4-4615-b4d8-d1e1b7f3bf55.

Request:

GET https://51.11.247.127/api/v2/policies/a1c3b4cb-29d4-4615-b4d8-d1e1b7f3bf55

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200

 

Response Body:

{

 "id": "a1c3b4cb-29d4-4615-b4d8-d1e1b7f3bf55",

 "priority": 1,

 "excludedItemsCount": 0,

 "usn": 1196,

 "snapshotStatus": "Success",

 "backupStatus": "Pending",

 "nextExecutionTime": "2020-11-24T10:00:00Z",

 "isBackupConfigured": true,

 "isScheduleConfigured": true,

 "_links": {

   "self": {

     "href": "https://51.11.247.127/api/v2/policies/a1c3b4cb-29d4-4615-b4d8-d1e1b7f3bf55"

   },

   "selecteditems": {

     "href": "https://51.11.247.127/api/v2/policies/a1c3b4cb-29d4-4615-b4d8-d1e1b7f3bf55/selectedItems"

   },

   "excludeditems": {

     "href": "https://51.11.247.127/api/v2/policies/a1c3b4cb-29d4-4615-b4d8-d1e1b7f3bf55/excludedItems"

   },

   "dailyschedulerepository": {

     "href": "https://51.11.247.127/api/v2/repositories/1"

   }

 },

 "name": "Backup Policy",

 "description": "Created by administrator",

 "tenantId": "3e924ba9-93bc-40d5-8a47-33f07b239a52",

 "retrySettings": {

   "retryCount": 3

 },

 "policyNotificationSettings": {

   "recipient": "admin@tech.com",

   "notifyOnSuccess": true,

   "notifyOnWarning": true,

   "notifyOnFailure": true

 },

 "isEnabled": true,

 "backupType": "AllSubscriptions",

 "snapshotSettings": {

   "additionalTags": [],

   "copyOriginalTags": false,

   "applicationAwareSnapshot": false,

   "userScripts": {

     "windows": {

       "scriptsEnabled": false,

       "repositorySnapshotsOnly": false,

       "ignoreExitCodes": false,

       "ignoreMissingScripts": false

     },

     "linux": {

       "scriptsEnabled": false,

       "repositorySnapshotsOnly": false,

       "ignoreExitCodes": false,

       "ignoreMissingScripts": false

     }

   }

 },

 "dailySchedule": {

   "dailyType": "Everyday",

   "runsPerHour": 1,

   "snapshotSchedule": {

     "hours": [

       0,

       1,

       2,

       3,

       4,

       5,

       6,

       7,

       8,

       9,

       10,

       11,

       12,

       13,

       14,

       15,

       16,

       17,

       18,

       19,

       20,

       21,

       22,

       23

     ],

     "snapshotsToKeep": 24

   },

   "backupSchedule": {

     "hours": [

       22

     ],

     "retention": {

       "timeRetentionDuration": 14,

       "retentionDurationType": "Days"

     },

     "targetRepositoryId": "1"

   }

 }

}

I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.