Enable Server Plan Database Add-on (REST API: PUT)

This operation enables backup options for the backup plan database.

Request

Syntax

PUT webservice/v2/plan/planId/Addon/Database/Action/Enable HTTP/1.1
Host: host name
Accept: application/xml | application/json
Authtoken: authentication token

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 Parameter

Name	Description	Required
planId	The plan ID for the plan. If the plan ID is not known, use the GET Plan API to retrieve it.	Yes

Request Headers

Name	Description
Host	The host name of the Web Server or the Command Center 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.

Response

Response Parameters

Parameter	Description	Element
errorMessage	A message describing any errors in the request. If there are no errors, this value is blank.	Api_PlanComponentErrorList/error
errorCode	A number representing the status of the request. Possible values are: 0, successful completion. 2, a failure. A specific error code.	Api_PlanComponentErrorList/error

Parameter

Description

Element

errorMessage

A message describing any errors in the request. If there are no errors, this value is blank.

Api_PlanComponentErrorList/error

errorCode

A number representing the status of the request. Possible values are:

0, successful completion.
2, a failure.
A specific error code.

Api_PlanComponentErrorList/error

Examples

Sample Request

The following sample requests enable the backup plan database add-on.

PUT webservice/v2/plan/2/Addon/Database/Action/Enable HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
 Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc60f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef768fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f3233d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8

Sample Response

XML

<Api_PlanComponentErrorList> <error> <entity /> <status errorMessage="" errorCode="0" /> </error>
</Api_PlanComponentErrorList>

JSON

{ "error": [ { "entity": { "_type_": 158 }, "status": { "errorMessage:" "Success", "", "errorCode": 0 } } ]
}

Enable Backup Plan Database Add-on (REST API: PUT)