Create a Backup Policy (Experimental) - RESTful API Reference
Help Center
Choose product document...
Veeam Availability Console 2.0 Update 1
RESTful API Reference

Create a Backup Policy (Experimental)

You can add a backup policy into Veeam Availability Console configuration.

Request

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

HTTP Request

POST https://<Availability-Console>:1281/v2/BackupPolicies

Request Headers

The request header must contain the authorization token for the current logon session.

Request Body

In the request body, the client must send the properties for the backup policy that should be added to Veeam Availability 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

Response

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.

Header

Description

Content-length

The length of the response body.

Content-type

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

Response Body

In the response body, Veeam Availability 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 Availability Console configuration.

Request:

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 RESTful API.",

 }

 

Response Code:

201 Created

 

Response Body:

"Backup policy was created"

Veeam Large Logo

Deployment Guide

Administrator Guide for Service Providers

User Guide for Service Providers

Quick Start Guide for Service Providers

Administrator Guide for Enterprises

User Guide for Enterprises

Quick Start Guide for Enterprises

RESTful API Reference