This operation disables snapshot backups for a server plan. This operation does not delete the configuration information.
Request
Syntax
Send the request using either XML or JSON:
-
XML
PUT webservice/v2/plan/planId/Addon/Snap/Action/Disable HTTP/1.1 Host: host name Accept: application/xml Authtoken: authentication token -
JSON
PUT webservice/v2/plan/planId/Addon/Snap/Action/Disable HTTP/1.1 Host: host name Accept: 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 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. |
Response
Response Parameters
|
Parameter |
Description |
XML Element |
JSON Key |
|---|---|---|---|
|
errorMessage |
A message describing any errors in the request. If there are no errors, this value is blank. |
Api_PlanComponentErrorList/error |
status |
|
errorCode |
A number representing the status of the request. Possible values are:
|
Api_PlanComponentErrorList/error |
status |
Examples
Sample Request
The following sample requests enable the server plan snapshot backups and set the number of recovery points to eight and the snapshot backup frequency to four hours.
-
XML
PUT $[webservice]/v2/plan/$[2]/Addon/Snap/Action/Disable HTTP/1.1 Host: $[client.mydomain.com] Accept: application/xml Authtoken: $[QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc60f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef768fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f3233d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8] -
JSON
PUT $[webservice]/v2/plan/$[2]/Addon/Snap/Action/Disable HTTP/1.1 Host: $[client.mydomain.com] Accept: application/json Authtoken: $[QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc60f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef768fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f3233d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8]
Sample Response
-
XML
<Api_PlanComponentErrorList> <error> <entity /> <status errorMessage="" errorCode="0" /> </error> </Api_PlanComponentErrorList> -
JSON
If the operation is successful, then the response will be similar to the following:
{ "error": [ { "entity": { "_type_": 158 }, "status": { "errorMessage:" "Success", "", "errorCode": 0 } } ] }If the operation fails, then the response will be similar to the following:
{ "error": [ { "entity": { "_type_": 158 }, "status": { "errorMessage": "Failed to disable snap addon for plan as some subclients with intellisnap enabled are associated with it. Please reassociate them to other plan and try again.", "errorCode": 104 } } ] }