REST API - POST Disaster Recovery Backup

This operation runs a disaster recovery backup job.

Syntax

Send the request using either XML or JSON:

XML

POST <webservice>/CommServ/DRBackup HTTP/1.1
Host: <host name>
Accept: application/xml
Authtoken: <authentication token>
Content-type: application/xml
<TMMsg_CommcellDRBackupReq isCompressionEnabled="" jobType="IMMEDIATE" backupType="" />

JSON

POST <webservice>/CommServ/DRBackup HTTP/1.1
Host: <host name>
Accept: application/json
Authtoken: <authentication token>
Content-type: application/json
{
"isCompressionEnabled":"","jobType":1,"backupType":""
}

where <webservice> is the root path used to route the API requests to the Web Server.

For more information, see Available Web Services for REST API.

Request Headers

Name	Description
Host	The host name of the Web Server or Web Console used in the API request.
Accept	The format of the response. Valid values are: application/xml or application/json.
Authtoken	The authentication token received after successfully logging on. For details on receiving an authentication token, see Authentication.
Content-type	The media type contained in the request body.

Request Body

An XML element or a JSON message is required. The following table displays the parameters for the request body.

Parameter	Description	Element
isCompressionEnabled	The option to compress the database backup file (*.dmp). Selecting this option compresses the backup file, not the database. Valid values are true/false.	TMMsg_CommcellDRBackupReq
jobType	When to run the job. JSON valid value is 1, to run the job immediately. XML valid value is immediate.	TMMsg_CommcellDRBackupReq
backupType	The type of backup job. JSON valid values are: 1, for a full backup 3, for a differential backup XML valid values are: full differential	TMMsg_CommcellDRBackupReq

Parameter

Description

Element

isCompressionEnabled

The option to compress the database backup file (*.dmp). Selecting this option compresses the backup file, not the database.

Valid values are true/false.

TMMsg_CommcellDRBackupReq

jobType

When to run the job.

JSON valid value is 1, to run the job immediately.

XML valid value is immediate.

TMMsg_CommcellDRBackupReq

backupType

The type of backup job.

JSON valid values are:

1, for a full backup
3, for a differential backup

XML valid values are:
full
differential

TMMsg_CommcellDRBackupReq

Response

Response Parameters

Parameter	Description	Element
taskId	The system-generated ID assigned to the task.	TMMsg_CreateTaskResp
val	The system-generated ID assigned to the job.	jobIds

Examples

Sample Request

XML

POST <webservice>/CommServ/DRBackup HTTP/1.1
 Host: client.mydomain.com
 Accept: application/xml
 Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
 0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
 8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
 40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
 68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
 3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
 Content-type: application/xml
 <TMMsg_CommcellDRBackupReq isCompressionEnabled="1" jobType="IMMEDIATE" backupType="full"/>

JSON

POST <webservice>/CommServ/DRBackup HTTP/1.1
 Host: client.mydomain.com
 Accept: application/json
 Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
 0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
 8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
 40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
 68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
 3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
 Content-type: application/json
{
"isCompressionEnabled":"false","jobType":1,"backupType":"1"
}

Sample Response

XML

<TMMsg_CreateTaskResp taskId="434">
   <jobIds val="2142" />
 </TMMsg_CreateTaskResp>

JSON

{
   taskId": 433,
   jobIds": [
     "2141"
   ]
 }