REST API - DELETE Alert

This operation deletes an alert.

Request

Syntax

DELETE webservice/AlertRule/alertId HTTP/1.1
 Host: host name
 Accept: application/xml
 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 Parameters

Name	Description	Required
alertId	The alert ID for the alert. If the alert ID is not known, use the GET Alert 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
errorCode	The possible error codes. Valid values are: 0, successful completion. 2, a failure. a specific error code.	CVGui_GenericResp
errorMessage	The description of the error code. Not all error codes have an error message.	CVGui_GenericResp

Parameter

Description

Element

errorCode

The possible error codes.

Valid values are:

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

CVGui_GenericResp

errorMessage

The description of the error code. Not all error codes have an error message.

CVGui_GenericResp

Examples

Sample Request

DELETE webservice/AlertRule/77 HTTP/1.1
 Host: client.mydomain.com
 Accept: application/xml
 Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc60f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef768fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f3233d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8

Sample Response

This is the response when the alert is deleted.

<CVGui_GenericResp errorCode="0" errorMessage="Successfully deleted the alert : No Media in Stand Alone Tape drive Alert " />

These are the possible responses when the alert ID in the request is not valid.

<CVGui_GenericResp errorMessage="Invalid Rule Id [7s]" errorCode="1" />

<CVGui_GenericResp errorCode="720899" errorMessage="Alert notification not found" />

This is the response when a user does not have the alert management permission.

<CVGui_GenericResp errorCode="99" errorMessage="User [user2] does not have required capability [Alert Management] for this CommCell and this operation." />