Create a Backup Policy (Experimental)

In this article

    You can add a backup policy into Veeam Service Provider Console configuration.


    To create a backup policy in Veeam Service Provider Console, send the POST HTTPS request to the URL of the /backupPolicies resource.

    HTTP Request

    POST https://<hostname>:1281/v2/backupPolicies

    Request Headers

    The request header must contain the authorization token.

    Request Body

    In the request body, the client must send the properties for the backup policy that should be added to Veeam Service Provider Console. See the Properties section for the list of properties and their possible values.

    The following properties are system and should not be sent in the request:

    • id
    • modifiedDate
    • tenantsCount
    • type
    • createdBy
    • osType


    The server returns the following response to the client.

    Response Code

    A successfully completed operation returns response code 201 Created.

    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 status and a message for an action.

    Example Create a Backup Policy (Experimental)

    The following example adds a new server backup policy into Veeam Service Provider Console configuration.


    POST https://localhost:1281/v2/backupPolicies


    Request Header:

    Content-Type: application/json

    Authorization: Bearer <Access-Token>


    Request Body:


       "name": "Server: Entire computer. Daily schedule.",

       "retention": 14,

       "operationMode": "Server",

       "accessType": "Public",

       "guestIndexingSettings": {

         "indexingEnabled": false


       "guestProcessingSettings": {

         "processingEnabled": true,

         "processingType": "ProcessLogs",

         "sqlOptions": {

           "credentials": {

             "credentialsEnabled": false


           "truncationMode": "Truncate"


         "oracleOptions": {

           "credentials": {

             "credentialsEnabled": false


           "archivalMode": "NotDelete"


         "sharePointOptions": {

           "credentials": {

             "credentialsEnabled": false



         "scriptOptions": {

           "executionMode": "Disabled"



       "backupMode": "EntireComputer",

       "destinationType": "CloudRepository",

       "enableSubtenants": true,

       "quotaSize": 500,

       "quotaSizeUnits": "GB",

       "cacheEnabled": true,

       "cachePath": "C:\\Cache",

       "cacheSize": 10,

       "cacheSizeUnits": "GB",

       "schedulingEnabled": true,

       "advancedSettings": {

         "syntheticfullEnabled": false,

         "activefullEnabled": false,

         "compressionLevel": "Optimal",

         "storageOptimization": "Lan",

         "encryptionEnabled": false


       "serverOperationModeScheduleSetting": {

         "retryEnabled": true,

         "retryNumber": 3,

         "retryTimeout": 10,

         "retryTimeoutUnits": "mins",

         "terminationEnabled": false,

         "scheduleType": "Daily",

         "scheduleTypeDaily": {

           "dailyTime": "00:30",

           "dailyType": "EveryDay"



       "description": "A new backup policy created with REST API."



    Response Code:

    201 Created