This is an archive version of the document. To get the most up-to-date information, see the current version.

POST Method

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

To create a new resource, for example, a new backup policy
To perform an operation listed in the actions property, for example, start a failover plan or update a license

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://<hostname>: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 REST 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://<hostname>: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 OK response code.