> Expert > Tools & Utilities > Developer Tools > REST API > REST API Reference > Alert Operations

REST API - GET Alert Details

Updated

This operation returns the details associated with an alert.

Request

Syntax

GET <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 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

alertSeverity

The alert severity.

Valid values are:

  • 0, for Auto Pick

  • 1, for Critical

  • 2, for Warning

  • 3, for Information

alertDetail

customQueryDetailsXml

alertDetail

escalationSeverity

alertDetail

eventCriteriaXML

alertDetail

periodicNotificationInterval

alertDetail

xmlEntityList

The entities selected for the alert.

Examples

  • If all clients are selected as the entities for an alert, the clients includeAll setting equals 1, for example: &lt;clients includeAll=&quot;1&quot;/>.

  • If a storage policy is selected as the entity for an alert, the storagePolicyId setting equals the storage policy ID and the storagePolicyName setting equals the name of the storage policy, for example: storagePolicyId=&quot;10&quot; storagePolicyName=&quot;GLO_dep&quot;/>.

alertDetail

GUID

The globally unique identifier for the alert.

alert

createdTime

alert

description

The alert description.

alert

escNotifType

The option to escalate the notification criteria.

Valid values are:

  • 0, for no escalation

  • 8, for escalation

  • 10, for escalation and repeating the notification

  • 12, for escalation and notification when the condition clears

  • 14, for escalation, repeating the notification, notification when the condition clears

alert

notifType

The notification type for the alert. If multiple notification types exist, the sum of the notification types is returned. For example, the parameter to deliver alerts through email and through the console is val = "8193".

Valid values are:

  • 1, for email

  • 4, for SNMP

  • 8, for event viewer

  • 512, for save to disk

  • 1024, for RSS feeds

  • 8192, for console alerts

  • 32768, for SCOM

  • 65536, for workflow

  • 131072, for content indexing

  • 2097152, for webhooks

alert

origCCId

alert

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:

  • 1: Alert is currently disabled.

  • 4: Alert is job based, schedule, or policy based alert.

  • 16: Option to send individual notifications for the alert is selected.

  • 128: Alert is subscription based.

  • 256: The alert is permanent and cannot be deleted (system-created alerts only).

  • 1024: Option to process discovered virtual machines is selected.

alert

id

The system-generated ID assigned to the alert.

alert

name

The name of the alert.

alert

id

The ID assigned to the alert category.

Valid values are:

  • 1, for Job Management

  • 2, for Configuration

  • 3, for Media Management

  • 5, for Software Updates

  • 8, for Operation

  • 9, for Others

alertCategory

name

The name of the alert category.

alertCategory

id

The ID assigned to the alert type.

Valid values are:

  • 1, for Data Aging

  • 2, for Auxiliary Copy

  • 3, for Data Protection

  • 4, for Data Recovery

  • 5, for Disaster Recovery Backup

  • 6, for Data Verification

  • 7, for Media Inventory

  • 8, for scheduled export

  • 9, for Media Erase

  • 10, for Client

  • 11, for agents

    1. for CommCell

  • 13, for MediaAgents

  • 14, for Schedules

  • 15, for Storage Policy

  • 16, for Library

  • 17, for Library Management

  • 18, for VaultTracker

  • 19, for Download Software

  • 20, for Install Updates

  • 21, for Device Status

  • 22, for Erase Data

  • 23, for application exchange

  • 24, for Updates Available for Download

  • 25, for File Replication

  • 26, for Upgrades and Service Packs

  • 27, for Data Classification

  • 28, for Continuous Data Replication

  • 29, for offline content indexing

  • 30, for SharePoint

  • 52, for Report

  • 53, for Information Management

  • 54, for Media Refreshing

  • 55, for DeDup DB Reconstruction

  • 57, for Log Monitoring

  • 58, for Event Viewer Events

  • 59, for Client Group

  • 60, for License

  • 61, for Backup Copy Workflow

  • 62, for log monitoring for Windows events

  • 63, for Workflow

  • 64, for Virtualize Me

  • 65, for custom queries When the alertCatagory element id parameter equals 9, the alertType element id parameter equals the query ID.

alertType

name

The name of the alert type.

alertType

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

criteriaId

The alert criteria.

Valid values are:

  • 1, for Job Succeeded

  • 2, for Alert every n attempts (Phase failures)

  • 3, for Job Failed

  • 4, for Job Skipped

  • 5, for Delayed by n Hrs

  • 7, for Job Initiated

  • 8, for Rolled Back

  • 10, for Media Handling Required

  • 11, for Media Picked Up

  • 12, for Media Reached Destination

  • 13, for Media Returned to Source

  • 14, for Job Activity

  • 16, for Properties Modified

  • 17, for Alert Modified

  • 18, for Disk Space Low

  • 19, for Force De-configured

  • 20, for Library went Offline

  • 21, for Scheduler Changes

  • 22, for Insufficient Storage

  • 26, for Maintenance Required

  • 27, for Maintenance Occurred

  • 28, for User Overwrite of Media

  • 29, for Drive went Offline

  • 30, for MediaAgent went offline

  • 31, for Mount Path went Offline

  • 32, for Alert every n attempts (Network failures)

  • 38, for Updates Available to Download

  • 39, for Release Upgrade Required

  • 46, for No Data Protection

  • 47, for Classification Failed

  • 51, for Media Recalled

  • 52, for Increase in Data size by n %

  • 53, for Decrease in Data size by n %

  • 54, for Job Started

  • 55, for Alert every n failed login attempts

  • 56, for Auxiliary Copy fallen behind alert

  • 57, for Job Succeeded with Errors

  • 58, for Alert CommServe License Expires Within n Days

  • 60, for Alert when License Consumed reaches n Percent

  • 63, for Non-encrypted media exported

  • 65, for No Backup for last n Days

  • 66, for Alert when client certificate Expires Within n Days

  • 67, for Job exceeded running time of n Hrs

  • 68, for Number of failed files is more than n

  • 69, for Percentage of failed files is more than n

  • 70, for DDB Store got corrupted

  • 71, for Backup for subclient failed consecutively for n attempts

  • 72, for DDB disk space low

  • 73, for Alert when jobs in pending state exceed n percent or count of n

  • 74, for Data backed up exceeds n GB

criteria

delayTimeSeconds

criteria

esclationLevel

criteria

persistTimeSeconds

criteria

reportId

criteria

reportingOptions

The option to set notification criteria.

Valid values are:

  • 257, to notify if a condition persists

  • 3, to repeat the notification

  • 5, to notify when the condition clears

  • 259, to notify if a condition persists and to repeat the notification

  • 261, to notify if a condition persists and to notify when the condition clears

  • 7, to repeat the notification and to notify when the condition clears

  • 263, to notify if a condition persists, to repeat the notification, and to notify when the condition clears

criteria

taskId

criteria

value

criteria

paramIndex

criteriaParams

type

criteriaParams

unit

criteriaParams

value

criteriaParams

localeID

locale

esclationLevel

notifMsgs

localeId

notifMsgs

messageFormat

The format of the alert notification message.

Valid values are:

  • 1, for html

  • 0, for text

notifMsgs

notifMessage

The body of the alert notification message as text.

Example: "Detected Criteria: &lt;DETECTED CRITERIA> , Status: &lt;STATUS> , Job ID: &lt;JOB ID> , Storage Policy Name: &lt;SP NAME> , Start Time: &lt;START TIME> , Scheduled Time: &lt;SCHEDULE TIME> , End Time: &lt;END TIME> , Error Code: &lt;ERR CODE> , Failure Reason: &lt;FAILURE REASON>"

notifMsgs

notifMessageHtml

The body of the alert notification message as html.

notifMsgs

notifOptions

notifMsgs

notifType

The notification type for the alert notification message.

Valid values are:

  • 1, for email

  • 4, for SNMP

  • 8, for event viewer

  • 512, for save to disk

  • 1024, for RSS feeds

  • 8192, for console alerts

  • 32768, for SCOM

  • 65536, for workflow

  • 131072, for content indexing

notifMsgs

_type_

entity

clientSidePackage

entity

consumeLicense

entity

type

entity

baseLocation

The base location of the RSS feed, for example: http://client.mydomain.com:81/rss. This parameter is populated when the notifType parameter equals 1024 (RSS feeds).

feeds

rssFeedLocation

feeds

selectedChannel

The channel selected for the feed. The possible channels are in val parameters in <channelNames> elements. This parameter is populated when the notifType parameter equals 1024 (RSS feeds).

feeds

seperateIndex

feeds

val

The possible channels for the feed. The channel selected for the alert notification message feed is in the selectedChannel parameter.

channelNames

alertLocation

The location where the alert is stored, for example: C:\documents\alerts. This parameter is populated when the notifType parameter equals 512 (save to disk).

saveAlertToDisk

cvpassword

saveAlertToDisk

impersonateUser

The option to impersonate a user. If this option is used, the notifType parameter must equal 512 (save to disk).

Valid values are 0/1.

saveAlertToDisk

loginName

If impersonateUser equals 1, this is the user name used to access the network path.

saveAlertToDisk

password

If impersonateUser equals 1, this is the user password used to access the network path.

saveAlertToDisk

useNetworkShare

The option to use a network share as the location where the alert is stored. If this option is used, the notifType parameter must equal 512 (save to disk).

Valid values are 0/1.

saveAlertToDisk

Examples

Sample Request

GET <webservice>/AlertRule/20 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" standalone="no" ?>
<CVGui_AlertDetailResp> <alertDetail alertSeverity="0" customQueryDetailsXml="" escalationSeverity="0" eventCriteriaXML="" periodicNotificationInterval="0" xmlEntityList="&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot; standalone=&quot;no&quot; ?>&lt;CVGui_CommCellTreeNode>&lt;clientGroups includeAll=&quot;0&quot;/>&lt;clients includeAll=&quot;0&quot;/>&lt;commcells includeAll=&quot;0&quot;/>&lt;criterias includeAll=&quot;0&quot;/>&lt;libraries includeAll=&quot;0&quot;/>&lt;mediaAgents includeAll=&quot;0&quot;/>&lt;storagePolcies includeAll=&quot;0&quot;/>&lt;trackingJobs/>&lt;trackingPolicies includeAll=&quot;0&quot;/>&lt;trackingSchedules/>&lt;workflows includeAll=&quot;0&quot;/>&lt;/CVGui_CommCellTreeNode>"> <alert GUID="C79C2698-348F-4EE1-9B1F-C3B09E929CF7" createdTime="0" description="" escNotifType="0" notifType="131073" origCCId="2" status="144"> <alert id="20" name="No backup for last 4 days"/> <alertCategory id="1" name="Job Management"/> <alertType id="3" name="Data Protection"/> <creator id="0" name=""/> </alert> <criteria criteriaId="65" delayTimeSeconds="0" esclationLevel="1" persistTimeSeconds="0" reportId="0" reportingOptions="1" taskId="0" value=""> <criteriaParams paramIndex="0" type="2" unit="5" value="4"/> </criteria> <locale localeID="0"/><notifMsgs esclationLevel="1" localeId="0" messageFormat="1" notifMessage="&lt;SUBJECT BEGIN> Alert: &lt;ALERT NAME> Type: &lt;ALERT CATEGORY - ALERT TYPE> &lt;IS ESCALATED?> &lt;SUBJECT END>MsgNewLine_MsgTab_ Alert: &lt;ALERT NAME> MsgNewLine_MsgTab_ CommCell: &lt;COMMCELL NAME> MsgNewLine_MsgTab_ Your computer: [&lt;CLIENT NAME>] has not been backed up in over: &lt;NO SUCCESSFUL JOB SINCE> MsgNewLine_MsgTab_ The last recorded backup was on: [&lt;DATE OF LAST SUCCESSFUL JOB>] at: [&lt;TIME OF LAST SUCCESSFUL JOB>] MsgNewLine_MsgTab_ It is suggested that you perform a backup as soon as possible so as to not lose any data. MsgNewLine_MsgTab_ You can do this by clicking the &quot;Backup Now&quot; button on the CommVault Edge Monitor control in the Taskbar Notification area. MsgNewLine_MsgTab_ " notifMessageHtml="&lt;SUBJECT BEGIN> Alert: &lt;ALERT NAME> Type: &lt;ALERT CATEGORY - ALERT TYPE> &lt;IS ESCALATED?> &lt;SUBJECT END>&lt;style type=&quot;text/css&quot;>&lt;!--body { background-image: url(cid:bgc.png) }hr { height: 1px; color: black }.content2 { background-color: WHITE; font-family: Calibri, Tahoma, Arial; width: 800px; padding-right: 50px; border-spacing: 0; padding-left: 50px; padding-bottom: 25px; padding-top: 25px; color: #666666 }.content1 { width: 800px; border-spacing: 0; padding-top: 20px }-->&lt;/style>&lt;div align=&quot;center&quot;>&lt;table class=&quot;content1&quot;>&lt;tr>&lt;td colspan=&quot;2&quot;>&lt;img alt=&quot;Cloud Image&quot; src=&quot;cid:AlertCloud_header.PNG&quot; border=&quot;0&quot;>&lt;/td>&lt;/tr>&lt;tr>&lt;td width=&quot;10%&quot;>&amp;#160;&amp;#160;&lt;/td>&lt;td>&lt;p>&lt;font color=&quot;#666666&quot; face=&quot;Calibri,sans-serif&quot;>&lt;span>Your Computer: [&lt;b>&amp;lt;CLIENT NAME&amp;gt;&lt;/b>] has not backed up in over: &lt;b>&amp;lt;NO SUCCESSFUL JOB SINCE&amp;gt;&lt;/b> &lt;/span>&lt;/font>&lt;/p>&lt;p>&lt;font color=&quot;#666666&quot; face=&quot;Calibri,sans-serif&quot;>&lt;span>The last recorded backup was on: [&lt;b>&amp;lt;DATE OF LAST SUCCESSFUL JOB&amp;gt;&lt;/b>] at: [&lt;b>&amp;lt;TIME OF LAST SUCCESSFUL JOB&amp;gt;&lt;/b>] &lt;/span>&lt;/font>&lt;/p>&lt;p>&lt;b>&lt;font color=&quot;#ff0033&quot; face=&quot;Calibri,sans-serif&quot;>&lt;span>It is suggested that you perform a backup as soon as possible so as to not lose any data.&lt;/span>&lt;/font>&lt;/b>&lt;font color=&quot;#666666&quot; face=&quot;Calibri,sans-serif&quot;>&lt;span> &lt;/span>&lt;/font>&lt;/p>&lt;p>&lt;font color=&quot;#666666&quot; face=&quot;Calibri,sans-serif&quot;>&lt;span>You can do this by clicking the &amp;quot;Backup Now&amp;quot; button on the CommVault Edge Monitor control in the Taskbar Notification area. &lt;/span>&lt;/font>&lt;/p>&lt;/td>&lt;/tr>&lt;/table>&lt;/div>" notifOptions="2" notifType="1"> <entity _type_="0" clientSidePackage="1" consumeLicense="1" type="0"/> <feeds baseLocation="" rssFeedLocation="" selectedChannel="" seperateIndex="0"/> <saveAlertToDisk alertLocation="" cvpassword="" impersonateUser="0" loginName="" password="||#1!" useNetworkShare="0"/>
</notifMsgs>
</alertDetail>
</CVGui_AlertDetailResp>