This operation returns a list of alerts.
Request
Syntax
GET <webservice>/AlertRule 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 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 |
Element |
||
---|---|---|---|---|
myReceiveTotal |
The total number of alerts received. |
CVGui_AlertListResp |
||
myCreatedTotal |
The total number of alerts created. |
CVGui_AlertListResp |
||
description |
The alert description. |
alertList |
||
createdTime |
The date and time the alert was created. Valid values are UNIX-style timestamps (seconds since January 1, 1970). |
alertList |
||
notifType |
The notification type for the alert. If multiple notification types are needed, send the sum of the notification types. For example, the parameter to deliver alerts through email and through the console is val = "8193". Valid values are:
|
alertList |
||
status |
The status for the alert. If multiple status types are needed, then the sum of individual status values are used. For example, a status value of 2193 means the alert is disabled (1), has the option to send individual notifications selected (16), and is a system created alert (2048). Valid individual status values are:
|
alertList |
||
id |
The system-generated ID assigned to the alert. |
alert |
||
name |
The name of the alert. |
alert |
||
id |
The system-generated ID assigned to the user who created the alert. |
creator |
||
name |
The name of the user who created the alert. |
creator |
||
id |
The ID assigned to the alert category. Valid values are:
|
alertCategory |
||
name |
The name of the alert category. |
alertCategory |
||
id |
The ID assigned to the alert type. Valid values are:
|
alertType |
||
name |
The name of the alert type. |
alertType |
Examples
Sample Request
GET <webservice>/AlertRule HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
Sample Response
<?xml version='1.0' encoding='utf-8' ?>
<CVGui_AlertListResp myReceiveTotal="48" myCreatedTotal="48">
<alertList description="" createdTime="1389380460" notifType="131073" status="144">
<alert id="20" name="No backup for last 4 days"/>
<creator id="1" name="admin"/>
<alertCategory id="1" name="Job Management"/>
<alertType id="3" name="Data Protection"/>
</alertList>
<alertList description="" createdTime="1400738424" notifType="131073" status="0">
<alert id="43" name="LOG alert"/>
<creator id="1" name="admin"/>
<alertCategory id="8" name="Operation"/>
<alertType id="57" name="Log Monitoring"/>
</alertList>
<alertList description="" createdTime="1390852120" notifType="131073" status="1">
<alert id="54" name="Content Indexing - Low Disk Space"/>
<creator id="1" name="admin"/>
<alertCategory id="8" name="Operation"/>
<alertType id="58" name="Event Viewer Events"/>
</alertList>
<alertList description="" createdTime="1390852113" notifType="131073" status="1">
<alert id="56" name="Schedule_1"/>
<creator id="10" name="jdoe"/>
<alertCategory id="2" name="Configuration"/>
<alertType id="14" name="Schedules"/>
</alertList>
<alertList description="" createdTime="1390852103" notifType="131073" status="1">
<alert id="68" name="Updates available for download"/>
<creator id="1" name="admin"/>
<alertCategory id="5" name="Software Updates"/>
<alertType id="24" name="Updates Available to Download"/>
</alertList>
<alertList description="" createdTime="1403207885" notifType="131073" status="0">
<alert id="77" name="is_Custom"/>
<creator id="1" name="admin"/>
<alertCategory id="9" name="Others"/>
<alertType id="2" name="custom_alert"/>
</alertList>
</CVGui_AlertListResp>