Help Center
Choose product document...
Veeam Availability Console 2.0 Update 1
RESTful API Reference

POST Method

The POST HTTP method can be used in two different ways:

Post a New Resource

All requests that create a new resource require a request body. The body must contain properties for this resource. For example, to create a new backup policy, send the following request:

Request:

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

 

Request Header:

Content-Type: application/json

Authorization: Bearer

 

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

 }

Post an Action

All requests that perform an action require a request body. The body must contain an action property. For example, to undo a failover plan, send the following request:

Request:

POST https://<Availability-Console>:1281/v2/FailoverPlans/{ID}/action

 

Request Header:

Content-Type: application/json

Authorization: Bearer

 

Request Body:

{"undo": null}

In case of success, the POST HTTP method returns the 201 Created or 200 Success response code.

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