Get a Backup Policy

In this article

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


    To get a resource representation of a specific backup policy, send the GET HTTPS request to the URL of its resource.

    HTTP Request

    GET https://<hostname>:1281/v2/backupPolicies/{ID}

    Request Headers

    The request header must contain the authorization token.


    The server returns the following response to the client:

    Response Code

    A successfully completed operation returns response code 200 OK.

    Response Headers

    The response to this request contains the following headers. The response may also include additional standard HTTP headers.




    The length of the response body.


    The media type and syntax of the request body message: application/json; charset=utf-8

    Response Body

    In the response body, Veeam Service Provider Console returns a representation of the /backupPolicies/{ID} resource.

    Example Get a Backup Policy

    The following example returns an entity representation of a backup policy with ID 1.


    GET https://localhost:1281/v2/backupPolicies/1


    Request Header:

    Authorization: Bearer <Access-Token>


    Response Code:

    200 Success


    Response Body:


       "id": 1,

       "name": "Workstation. Cloud Repository. Daily schedule.",

       "retention": 14,

       "operationMode": "Workstation",

       "accessType": "Public",

       "backupMode": "EntireComputer",

       "destinationType": "CloudRepository",

       "enableSubtenants": true,

       "quotaSize": -1,

       "quotaSizeUnits": "GB",

       "cacheEnabled": false,

       "advancedSettings": {

         "syntheticfullEnabled": false,

         "activefullEnabled": false,

         "compressionLevel": "Optimal",

         "storageOptimization": "Lan",

         "encryptionEnabled": false,

         "enableDeletedRetention": false,

         "retainsDays": 30,

         "dayNumber": 0


       "workstationOperationModeScheduleSetting": {

         "backupAtLock": false,

         "backupAtLogoff": false,

         "backupAtTargetConnection": false,

         "ejectTargetAfterwards": false,

         "backupTimeout": 2,

         "backupTimeoutUnit": "Hours",

         "dailyScheduleEnabled": true,

         "dailySchedule": {

           "dailyTime": "00:30",

           "dailyType": "EveryDay"


         "shutdownAction": "ResumeBackup",

         "postbackAction": "RemainsRunning"


       "type": "Created by Provider",

       "tenantsCount": 8,

       "modifiedDate": "2017-09-12T05:41:06Z",

       "description": "This policy processes the entire workstation.",

       "createdBy": "Cloud Provider",

       "_links": {

         "self": {

           "href": "https://vac:1281/v2/backupPolicies/1"